hosting

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

Remove sites from a group.

All hosting endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the sites.groups.manage permission; a key without it is refused with 403, not 404.

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 DELETE 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

Takes the named sites out of the group. The sites themselves are untouched. 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