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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

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