FalconryScale
DevelopersAPI reference

Update a raptor’s weight-alert thresholds

Changes the weight-alert thresholds. Only the fields you send change; null turns a threshold off. Needs edit rights on the bird.

PATCH
/raptors/{raptorId}/weight-alert-settings

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

raptorId*string

A raptor's id, from list_raptors.

Lengthlength <= 64

Request Body

application/json
  1. body
alertsEnabled?boolean
rapidDropPercent?|null
alertWeightMinGrams?|null
alertWeightMaxGrams?|null

Response Body

Update a raptor’s weight-alert thresholds

application/json
  1. response
alertsEnabled*boolean
rapidDropPercent*|

Alert when weight drops by more than this percent in 24 hours. null = off.

alertWeightMinGrams*|

Alert below this weight, grams. null = off.

alertWeightMaxGrams*|

Alert above this weight, grams. null = off.

Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/raptors/string/weight-alert-settings' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "alertsEnabled": true,
  "rapidDropPercent": 0,
  "alertWeightMinGrams": 0,
  "alertWeightMaxGrams": 0
}