hosting

POST `/v1/site-groups`

Create a site group.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Gated on `sites.groups.manage` in addition to `sites.view`. Refused with 422 when the organisation's plan does not sell `site_groups`, when the name is blank or already taken (case-insensitively, per organisation), or when the organisation already holds the maximum number of groups.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`name`	`string`	Sì	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	No	—
`notes`	`string`	No	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`string`	Sì	—
`name`	`string`	Sì	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>`	Sì	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`	Sì	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Sì	—
`created_at`	`string`	Sì	—
`updated_at`	`string`	Sì	—

Errori che questo endpoint può restituire

401 · 403 · 422

POST /v1/site-groups