agency-board
PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels
Set the labels on a card.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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[]> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
boardId (path) | Uuid | Ja | Project board ID (UUIDv7). |
cardId (path) | Uuid | Ja | Board card ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
label_ids | string[] | Ja | 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 | Nee | — |
updated_by | AgencyBoardActor | Nee | Who last edited this card. Moves exactly when `updated_at` does. |
assignee | AgencyBoardActor | Nee | The resolved form of `assignee_id`. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
column_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | Ja | — |
body | string | Nee | — |
visibility | AgencyBoardVisibility | Ja | 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 | Ja | — |
assignee_id | string | Nee | — |
due_at | string | Nee | — |
created_by_client | boolean | Nee | Whether the client raised this card themselves. |
archived_at | string | Nee | — |
cover_colour | AgencyBoardLabelColour | Nee | 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[] | Nee | 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 | Nee | — |
updated_at | string | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422