consultations

Update additional info

Creates or replaces the free-text additional information for a consultation. The text is used the next time a clinical note or other document is generated; saving it does not regenerate existing documents. Idempotent: sending the same text again has no further effect. Returns 403 for archived consultations.

put/workspaces/{workspaceId}/consultations/{consultationId}/additional-info

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/additional-info
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

additionalInfostring required

Text to store, 1 to 10,000 characters, in any language. Replaces the previous value entirely (there is no append). Because empty strings are rejected, saved text cannot be cleared through the API.

Example request

{
  "additionalInfo": "Blood panel 2026-09-10: ALT 85 U/L (slightly elevated), creatinine normal. Owner reports reduced appetite for two days."
}

Response

Additional information saved.

successboolean required

Always true when the text was saved.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.