groups

Update Group Membership

Current groups HTTP operation. External credential scopes: write:groups. Minimum farm role: EDITOR. Explicitly add and remove group members. Pass the membership_fingerprint from a fresh group read; a stale fingerprint is a 409 conflict. add_animal_ids and remove_animal_ids must not overlap, every target must be on this farm, and additions must be active. Already-present additions and already-absent removals are no-ops. Removal unlinks membership only; it changes no animal status, record, count observation or saved birth link, and cannot be undone.

post/v1/farm/{farm_id}/groups/{group_id}/membership

Request

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

Path parameters

farm_idstring uuid required
group_idstring uuid required

Request body

add_animal_idsstring[]

Active same-farm animal UUIDs to add.

remove_animal_idsstring[]

Same-farm animal UUIDs to unlink.

membership_fingerprintstring required

From a fresh group read; a mismatch is a 409 conflict.

Response

Success

group_idstring uuid required
added_animal_idsstring[] required
removed_animal_idsstring[] required
member_animal_idsstring[] required
membership_fingerprintstring required
member_countinteger required

Changes

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