agency-board
PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels
Set the labels on a card.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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[]> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
cardId (path) | Uuid | Yes | Board card ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
label_ids | string[] | Yes | 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 | No | — |
updated_by | AgencyBoardActor | No | Who last edited this card. Moves exactly when updated_at does. |
assignee | AgencyBoardActor | No | The resolved form of assignee_id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
column_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | Yes | — |
body | string | No | — |
visibility | AgencyBoardVisibility | Yes | 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 that… |
position | integer | Yes | — |
assignee_id | string | No | — |
due_at | string | No | — |
created_by_client | boolean | No | Whether the client raised this card themselves. |
archived_at | string | No | — |
cover_colour | AgencyBoardLabelColour | No | 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[] | No | 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… |
created_at | string | No | — |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422