FalconryScale
DevelopersAPI reference

Update a medication course

Edits a medication course, for example to change the dosage or set an end date to finish it. Only the fields you send change; null clears an optional field.

PATCH
/medications/{medicationId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

medicationId*string

A medication course's id, from list_medications.

Lengthlength <= 64

Request Body

application/json
  1. body
name?string
Length1 <= length <= 200
dosage?string
Lengthlength <= 200
frequency?string
Lengthlength <= 200
startDate?string

ISO 8601 date (yyyy-mm-dd).

Match^\d{4}-\d{2}-\d{2}$
endDate?|

Set to end the course; null makes it open-ended again.

reminderEnabled?boolean
reminderTime?|null
linkedHealthRecordId?|null
notes?|null

Response Body

Update a medication course

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
name*string
dosage*string
frequency*string
startDate*string

ISO 8601 date (yyyy-mm-dd).

endDate*|

ISO 8601 date, or null for an open-ended course.

reminderEnabled*boolean
reminderTime*|

Daily reminder time, HH:MM (24-hour).

linkedHealthRecordId*|null
notes*string|null
doseLog*array<>

Logged doses, one per day, newest first (at most the last 60).

loggedByName*string|null
Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/medications/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "raptorId": "string",
  "name": "string",
  "dosage": "string",
  "frequency": "string",
  "startDate": "string",
  "endDate": "string",
  "reminderEnabled": true,
  "reminderTime": "string",
  "linkedHealthRecordId": "string",
  "notes": "string",
  "doseLog": [
    {
      "date": "string",
      "status": "taken",
      "loggedAt": "string"
    }
  ],
  "loggedByName": "string"
}

Get one medication course

Returns one medication course by id, with its dose log. 404s if it does not exist or is not visible to the caller.

Delete a medication course

Permanently deletes a medication course and its whole dose log. This cannot be undone. To simply finish a course, set its endDate with update_medication instead. Before deleting, confirm the course (name, raptor, dates) with the user.