agency-board
PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels
Set the labels on a card.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua 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[]> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
boardId (path) | Uuid | Sì | Project board ID (UUIDv7). |
cardId (path) | Uuid | Sì | Board card ID (UUIDv7). |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
label_ids | string[] | Sì | 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`. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
column_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | Sì | — |
body | string | No | — |
visibility | AgencyBoardVisibility | Sì | 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 | Sì | — |
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 vocab… |
created_at | string | No | — |
updated_at | string | No | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422