hosting

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

Rename or recolour a site group.

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`groupId (path)`	`string`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`name`	`string`	Non	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Non	—
`notes`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`name`	`string`	Oui	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>`	Oui	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`	Oui	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Oui	—
`created_at`	`string`	Oui	—
`updated_at`	`string`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

PATCH /v1/site-groups/{groupId}