---
title: "Export clinical note to Vettigo"
method: POST
path: "/workspaces/{workspaceId}/consultations/{consultationId}/vettigo/export"
tags: ["vettigo"]
---

# Export clinical note to Vettigo

`POST /workspaces/{workspaceId}/consultations/{consultationId}/vettigo/export`

## Request

- Base URL: `https://vetnio.com/api/v2`
- URL: `https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/vettigo/export`
- Auth: HTTP bearer

Adds the supplied clinical note as a new, dated note in a Vettigo animal's medical record, authored by the caller's Vettigo user and department. The animal is taken from the consultation: a consultation started from Vettigo for an animal, else the Vettigo animal synced to the consultation's patient, else the animal of the Vettigo appointment the consultation was started from.

The note text is taken from the request, not from the consultation's stored note. Not idempotent: every call adds another note.

Errors: `400` when the consultation is not linked to Vettigo, the note is empty or the request is invalid (all reported as `Invalid Vettigo request`); `401` when the caller has no linked Vettigo account or Vettigo rejects Vetnio's credentials; `404` when the consultation does not exist; `429` on Vettigo rate limiting; `500` for other Vettigo failures.

## Path parameters

- `workspaceId` string, required: Identifier of the Vetnio workspace (clinic). The caller must be a member. The Vettigo clinic used is the one the caller last launched Vetnio from, not something configured on the workspace.
- `consultationId` string, required: Vetnio consultation (UUID) whose Vettigo animal or appointment receives the note.

## Request body

- object
  - `clinicalNote` string, required: The note to write. Either HTML or plain text, or a JSON object serialised as a string (a structured note), which is written as one `Field name:` block per key with the key turned into a readable label. HTML is converted to plain text and characters Vettigo cannot store are replaced. Must not be empty after conversion.

## Response `200`

Export result, including the Vettigo animalID when resolved.

- VettigoExportResult: Confirmation that the clinical note was added to the animal's Vettigo medical record.
  - `status` 'ok', required: Always `ok`; failures are returned as errors.
  - `httpStatus` number, required: Always `200`. Kept for older clients.
  - `animalID` number, nullable, required: Vettigo animal id whose medical record received the note. `null` when the animal was resolved through the consultation's Vettigo appointment instead.

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `500`: Internal server error

---

[API](https://skmtc.dev/vetnio/apis/vetnio-api.md) - [All operations](https://skmtc.dev/vetnio/apis/vetnio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vetnio/apis/vetnio-api/revisions/d004afd5617d?raw)