agency-board
POST /v1/agency/boards/{boardId}/labels
Define a label.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/labels \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Labels are per BOARD, not per organisation — an agency running *Website relaunch* and *Monthly SEO* wants different vocabularies, and a shared org-wide list makes every picker a list of somebody else's categories. Names are unique per board, case-insensitively.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
name | string | Да | — |
colour | AgencyBoardLabelColour | Не | ⛔ A palette **token**, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Да | — |
colour | AgencyBoardLabelColour | Да | ⛔ A palette **token**, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig… |
position | integer | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422