hosting

PUT /v1/site-groups/{groupId}/sites

Replace a group's membership.

All hosting endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/site-groups/{groupId}/sites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_ids": <string[]> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Makes the membership exactly the sites given. Sites outside the group's own organisation are ignored rather than refused — naming them in an error would turn this into an existence oracle for another tenant's ids. Gated on `sites.groups.manage`.

Parameters

NameTypeRequiredWhat it is
groupId (path)stringYes

Request body

NameTypeRequiredWhat it is
site_idsstring[]Yes

Response

NameTypeRequiredWhat it is
addedintegerYes
removedintegerYes
site_countintegerYesThe group's membership after the change.

Errors this endpoint can return

401 · 403 · 404 · 422