Sign in

v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Patients

post/Patients/{id}/deceased

Path parameters

idstring required

Request body

deceasedDatestring date-time nullable required

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"
}