hosting

POST `/v1/site-groups`

Create a site group.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`name`	`string`	Так	—
`colour`	`string<slate, blue, green, amber, red, purple, teal, pink>`	Ні	—
`notes`	`string`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`name`	`string`	Так	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>`	Так	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`	Так	The operator's own note. Never published, never shown to anyone else.
`site_count`	`integer`	Так	—
`created_at`	`string`	Так	—
`updated_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 422

POST /v1/site-groups