hosting

PATCH `/v1/site-groups/{groupId}`

Rename or recolour a site group.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X PATCH https://api.zinndigital.com/v1/site-groups/{groupId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

Fields omitted from the body are left alone. Gated on `sites.groups.manage`.

Parameters

Naam	Type	Verplicht	Wat dit is
`groupId (path)`	`string`	Ja	—

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Nee	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Nee	—
`notes`	`string`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`string`	Ja	—
`name`	`string`	Ja	Unique per organisation, case-insensitively. Two groups called `Casino` and `CASINO` are a support ticket rather than a feature — nobody can tell them apart in a filter and half…
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Ja	A chip colour from a closed set, never a free hex value. The dashboard draws these through the design system's contrast-checked tone tokens; a customer-supplied colour would ren…
`notes`	`string`	Ja	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Ja	—
`created_at`	`string`	Ja	—
`updated_at`	`string`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}