v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Patients

put/Patients/{id}

Path parameters

idstring required

Request body

namestring nullable
speciesstring nullable
breedstring nullable
clientIdstring nullable
dateOfBirthstring date-time nullable
clearDateOfBirthboolean

Set to true to clear the date of birth (since null can't be distinguished from "not provided")

isEstimatedAgeboolean nullable
colorstring nullable
microchipNostring nullable
fixedboolean nullable
sexstring nullable
vaccinationStatusstring nullable
lastVaccinationDatestring date-time nullable
previousVetstring nullable
previousVetPhonestring nullable
isDeceasedboolean nullable

Whether the patient is deceased

deceasedDatestring date-time nullable

Date the patient was marked as deceased (set automatically when IsDeceased is set to true)

isActiveboolean nullable

Whether the patient is active

Response

OK

idstring

Unique patient identifier

namestring

The patient's name

speciesstring

The species name. References a species from GET /species endpoint.

speciesIdstring nullable

The species ID for programmatic lookups (e.g., location species restrictions).

breedstring

The breed name

dateOfBirthstring date-time nullable
isEstimatedAgeboolean
colorstring nullable
microchipNostring nullable
clientIdstring
clientNamestring nullable
clientPhonestring nullable
clientEmailstring nullable
fixedboolean
sexinteger
vaccinationStatusinteger
lastVaccinationDatestring date-time nullable
previousVetstring nullable
previousVetPhonestring nullable
createdAtstring date-time
updatedAtstring date-time
lastVisitDatestring date-time nullable
hasActiveAppointmentsboolean
isDeceasedboolean

Whether the patient is deceased

deceasedDatestring date-time nullable

Date the patient was marked as deceased

isActiveboolean

Whether the patient is active (not transferred, discharged, etc.)

profilePhotoUrlstring nullable

Presigned URL (~60min) for the patient's profile photo, or null if none is set. Backed by the PatientFile flagged with IsProfilePhoto.

Example response

{
  "species": "Dog",
  "breed": "Golden Retriever"
}