FalconryScale
DevelopersAPI reference

Edit a custom food item

Edits one of the caller's own custom food items (built-in items can't be edited: 404). Only the fields you send change; null clears an optional field.

PATCH
/food-items/{foodItemId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

foodItemId*string

A food item's id, from list_food_items.

Lengthlength <= 64

Request Body

application/json
  1. body
name?string
Match^[\p{L}\p{M}\p{N} '_-]+$
Length2 <= length <= 50
description?|null
foodType?|null
defaultWeightGrams?|null

Response Body

Edit a custom food item

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
name*string

Display name, e.g. "Quail".

description*string|null
foodType*|

'whole' (a whole animal) or 'portion' (a cut or part).

defaultWeightGrams*number|null
isCustom*boolean

True for an item the caller created (editable); false for a built-in item.

isFavorite*boolean
usageCount*number
lastUsedAt*string|null
Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/food-items/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "foodType": "whole",
  "defaultWeightGrams": 0,
  "isCustom": true,
  "isFavorite": true,
  "usageCount": 0,
  "lastUsedAt": "string"
}