agency-board

PUT `/v1/agency/boards/{boardId}/cards/{cardId}/labels`

Set the labels on a card.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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[]> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`boardId (path)`	`Uuid`	Sim	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Sim	Board card ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`label_ids`	`string[]`	Sim	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`	Não	—
`updated_by`	`AgencyBoardActor`	Não	Who last edited this card. Moves exactly when `updated_at` does.
`assignee`	`AgencyBoardActor`	Não	The resolved form of `assignee_id`.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	Sim	—
`body`	`string`	Não	—
`visibility`	`AgencyBoardVisibility`	Sim	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`	Sim	—
`assignee_id`	`string`	Não	—
`due_at`	`string`	Não	—
`created_by_client`	`boolean`	Não	Whether the client raised this card themselves.
`archived_at`	`string`	Não	—
`cover_colour`	`AgencyBoardLabelColour`	Não	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[]`	Não	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`	Não	—
`updated_at`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels