Update Notes

patch

https://unify.kolla.dev/vet/v1/animals/{animal}/notes/{note}

Updates a Notes entry

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

animal

string

required

The animal id.

note

string

required

The note id.

Query Params

update_mask

string

The list of fields to update.

Body Params

A representation of an Notes in the unifyvet

name

string

name ID of the Notes ;-)

short_description

string

Short description of the note

contact

string

required

Contact or owner of the animal

provider

string

required

Provider associated with the clinical note

user

string

User associated with the clinical note, either a staff member, user, or provider depending on the system

note_text

string

Text only representation of the note, if available

note

string

Formatted contents of the note.

parts

array of objects

Sometimes a system will split a note into multiple parts, such as for SOAP notes, if that is the case note_text and note will be empty, and the parts will be used instead.

parts

format

string

enum

The format of the note can be different depending on the source system, and we don't parse the notes so you are required to know the format of the note before you can use it.

Allowed:

200OK

defaultDefault error response