agency-board
PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels
Set the labels on a card.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X PUT https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/labels \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "label_ids": <string[]> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Replaces the card's whole label set. Every id is re-checked against **this board**, so a label from another board is refused rather than quietly attached.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
cardId (path) | Uuid | Да | Board card ID (UUIDv7). |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
label_ids | string[] | Да | The COMPLETE set the card should wear afterwards — this replaces, it does not add. An empty array takes every label off, which is why the array may be empty: an add/remove pair… |
created_by | AgencyBoardActor | Нет | — |
updated_by | AgencyBoardActor | Нет | Who last edited this card. Moves exactly when `updated_at` does. |
assignee | AgencyBoardActor | Нет | The resolved form of `assignee_id`. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
column_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | Да | — |
body | string | Нет | — |
visibility | AgencyBoardVisibility | Да | Who may see this object. `internal` is always the default. A **card** reaches the client only when it is `client` **and its column is too** — an AND, not inheritance, because th… |
position | integer | Да | — |
assignee_id | string | Нет | — |
due_at | string | Нет | — |
created_by_client | boolean | Нет | Whether the client raised this card themselves. |
archived_at | string | Нет | — |
cover_colour | AgencyBoardLabelColour | Нет | A colour band across the top of the card, or the empty string for none. ⛔ Shares the label palette rather than declaring a second one: two palettes on one screen is how a cover… |
labels | AgencyBoardLabel[] | Нет | The labels this card wears, in the board's label order. ⛔ Agency-only — the client's projection of a card carries no labels at all, because a label is the agency's private vocab… |
created_at | string | Нет | — |
updated_at | string | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422