DOCS / API REFERENCE

Replace flock members

PUT /v1/flocks/{flock_id}/members

PUTHenHouse API v1

Request

PUT /v1/flocks/{flock_id}/members

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
flock_idstringThe flock ID (path)
membersarrayList of user IDs

Example

curl -X PUT https://api.pollosoft.example/v1/flocks/flock_8f2a/members \
  -H "Authorization: Bearer $COOP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"members": []}'

Response

A successful call returns 200 OK with JSON like this:

{
  "id": "flk_31aa",
  "members": 6,
  "updated": true
}

Errors

IdempotencySend an Idempotency-Key header to make retries safe. We will return the original result instead of laying a second egg.