groups

Update Group

Current groups HTTP operation. External credential scopes: write:groups. 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. Update the group name/description and/or add animals. animal_ids is additive: it connects the listed animals and never removes existing members. Omit animal_ids (or send []) to leave membership unchanged. Every requested animal must be an active animal on this farm; any unknown, archived or other-farm animal rejects the whole request. A request with a nonempty animal_ids cannot be undone.

put/v1/farm/{farm_id}/groups/{group_id}

Request

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

Path parameters

farm_idstring uuid required
group_idstring uuid required

Request body

namestring
descriptionstring
animal_idsstring[]

Animal UUIDs to ADD to the group (additive; existing members are preserved). Omit or pass [] to leave membership unchanged. Cannot be undone.

Response

Success

idstring required
created_atstring date-time required
updated_atstring date-time required
namestring required
is_activeboolean required
farm_idstring required
descriptionstring nullable required

Changes

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