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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 422

POST /v1/site-groups