animals

Create Animal

Current animals HTTP operation. External credential scopes: write:animals. Minimum farm role: EDITOR. Direct requests execute without an app confirmation screen. Production rate limit: 100 requests per 15-minute window per device account, 1000 per browser session, otherwise per client IP. RateLimit headers report the current window; respect Retry-After on 429. inventory_status is separate from deletion: CURRENT, UNKNOWN, SOLD, DECEASED, or NOT_MANAGED. New animals default to CURRENT; use UNKNOWN when present inventory membership is unconfirmed. Status changes preserve profile history and identifiers.

post/v1/farm/{farm_id}/animals

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/animals
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required

Request body

metadataunknown
inventory_status'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED'

Response

Success

idstring required
created_atstring date-time required
updated_atstring date-time required
is_activeboolean required
farm_idstring required
metadataunknown required
inventory_status'CURRENT' | 'UNKNOWN' | 'SOLD' | 'DECEASED' | 'NOT_MANAGED' required

Changes

No recorded changes to this operation across all 1 revision of this API.