FalconryScale
DevelopersAPI reference

Correct a weigh-in

Corrects a logged weigh-in (a mistyped weight, the wrong time, a missing note). Only the fields you send change; null clears an optional field. The grams-per-hour figures are recalculated. Weight alerts are not re-run.

PATCH
/weights/{weightId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

weightId*string

A weigh-in's id, from get_weight_history or get_latest_weights.

Lengthlength <= 64

Request Body

application/json
  1. body
weightGrams?number

Grams.

Range0 < value <= 20000
measuredAt?string

ISO 8601 datetime, e.g. 2026-10-31T07:30:00Z.

Lengthlength <= 40
stomachState?string

Changing to 'empty' clears any prey details.

Value in"empty""fed"
preyTypeId?|null
preyAmountGrams?|null
notes?|null

Response Body

Correct a weigh-in

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
weightGrams*number
measuredAt*string

ISO 8601 datetime this weigh-in was measured at.

stomachState*string
Value in"empty""fed"
avgGph*|

Average grams-per-hour of weight change since the previous empty-stomach weigh-in, when computable.

notes*string|null
preyTypeId*|null
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
preyAmountGrams*number|null
loggedByName*string|null
Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/weights/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "weightGrams": 0,
  "measuredAt": "string",
  "stomachState": "empty",
  "avgGph": 0,
  "notes": "string",
  "preyTypeId": "string",
  "raptorId": "string",
  "preyAmountGrams": 0,
  "loggedByName": "string"
}