FalconryScale
DevelopersAPI reference

Update a health record

Edits a health record, for example to record the outcome or resolution date of an illness. Only the fields you send change; null clears an optional field. Team members may edit only records they logged; owners and admins may edit any.

PATCH
/health-records/{healthRecordId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Path Parameters

healthRecordId*string

A health record's id, from list_health_records.

Lengthlength <= 64

Request Body

application/json
  1. body
recordType?string
Value in"observation""treatment""vet_visit""vaccination""injury""illness""medication""lab_result""parasite_check""moult_note"
recordDate?string

ISO 8601 date (yyyy-mm-dd).

Match^\d{4}-\d{2}-\d{2}$
symptom?|null
symptomSeverity?|null
diagnosis?|null
treatment?|null
medicationName?|null
dosage?|null
frequency?|null
durationDays?|null
outcome?|null
vetName?|null
vetClinic?|null
vetContact?|null
nextAppointmentDate?|null
resolutionDate?|null
notes?|null

Response Body

Update a health record

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
recordType*string
Value in"observation""treatment""vet_visit""vaccination""injury""illness""medication""lab_result""parasite_check""moult_note"
recordDate*string

ISO 8601 date (yyyy-mm-dd).

symptom*string|null
symptomSeverity*|null
diagnosis*string|null
treatment*string|null
medicationName*string|null
dosage*string|null
frequency*string|null
durationDays*number|null
vetName*string|null
vetClinic*string|null
vetContact*string|null
nextAppointmentDate*string|null
resolutionDate*string|null
outcome*|null
notes*string|null
attachments*array<>
loggedByName*string|null
Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/health-records/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "raptorId": "string",
  "recordType": "observation",
  "recordDate": "string",
  "symptom": "string",
  "symptomSeverity": "mild",
  "diagnosis": "string",
  "treatment": "string",
  "medicationName": "string",
  "dosage": "string",
  "frequency": "string",
  "durationDays": 0,
  "vetName": "string",
  "vetClinic": "string",
  "vetContact": "string",
  "nextAppointmentDate": "string",
  "resolutionDate": "string",
  "outcome": "resolved",
  "notes": "string",
  "attachments": [
    {
      "fileName": "string",
      "mimeType": "string",
      "fileSizeBytes": 0
    }
  ],
  "loggedByName": "string"
}

Get one health record

Returns one health record by id. 404s if it does not exist or is not visible to the caller.

Delete a health record

Permanently deletes a health record AND its attached files. This cannot be undone. Before calling, read the record back to the user (type, date, raptor, and how many attachments it has) and get their explicit confirmation.