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.
bearerAuthAuthorizationBearer <token>A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.
raptorId*stringA raptor's id, from list_raptors.
length <= 64application/json- body
targetWeightGrams?numberThe weight to reach, grams. Defaults to the raptor's ready weight.
0 < value <= 20000startWeightGrams?numberThe weight to start from, grams. Defaults to the raptor's latest weigh-in.
0 < value <= 20000startDate?stringISO 8601 date the plan starts. Defaults to today (UTC).
^\d{4}-\d{2}-\d{2}$durationDays?integerPlan length in days. Defaults to the safe minimum; a too-short value is lengthened automatically so no day drops more than 1.5%.
7 <= value <= 180Start a bring-down plan
application/json- response
plan*curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/bring-down-plan' \
-H 'Content-Type: application/json' \
-d '{}'{
"plan": {
"scheduleId": "string",
"startWeightGrams": 0,
"startDate": "string",
"targetWeightGrams": 0,
"dayNumber": -9007199254740991,
"totalDays": -9007199254740991,
"dailyTargets": [
{
"day": -9007199254740991,
"date": "string",
"targetWeightGrams": 0
}
]
}
}Get a raptor’s active bring-down plan
Returns the raptor's active bring-down plan (bringing the bird from its start weight down to its ready weight safely, at most 1.5% a day): today's day number, the total days, and the target weight for every day, in grams. `plan` is null when none is running.
Stop the active bring-down plan
Stops the raptor's active bring-down plan (it is kept as an inactive schedule, not deleted). 404s if no plan is running.