FalconryScale
DevelopersAPI reference

Start a bring-down plan

Starts a bring-down plan for a raptor, the same as the app's Feeding plan screen: from its latest weigh-in down to its ready weight unless you pass other weights, over the safe minimum number of days. Fails with 409 if a plan is already running, and with 400 if there is no weigh-in or ready weight to default to. Returns the new plan's daily targets.

POST
/raptors/{raptorId}/bring-down-plan

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
targetWeightGrams?number

The weight to reach, grams. Defaults to the raptor's ready weight.

Range0 < value <= 20000
startWeightGrams?number

The weight to start from, grams. Defaults to the raptor's latest weigh-in.

Range0 < value <= 20000
startDate?string

ISO 8601 date the plan starts. Defaults to today (UTC).

Match^\d{4}-\d{2}-\d{2}$
durationDays?integer

Plan length in days. Defaults to the safe minimum; a too-short value is lengthened automatically so no day drops more than 1.5%.

Range7 <= value <= 180

Response Body

Start a bring-down plan

application/json
  1. response
plan*
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/bring-down-plan' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "plan": {
    "scheduleId": "string",
    "startWeightGrams": 0,
    "startDate": "string",
    "targetWeightGrams": 0,
    "dayNumber": -9007199254740991,
    "totalDays": -9007199254740991,
    "dailyTargets": [
      {
        "day": -9007199254740991,
        "date": "string",
        "targetWeightGrams": 0
      }
    ]
  }
}