agency-board

PATCH `/v1/agency/boards/{boardId}/cards/{cardId}`

Edit 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 PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⭐ Sending assignee_id: null unassigns; omitting the field leaves the assignee alone. The two are different requests and the API distinguishes them, because a null-means-absent API cannot express "unassign" at all.

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
`title`	`string`	No	—
`body`	`string`	No	—
`visibility`	`AgencyBoardVisibility`	No	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…
`assignee_id`	`string`	No	—
`due_at`	`string`	No	—
`cover_colour`	`string<neutral, info, violet, ok, warn, crit, >`	No	A palette token, or the empty string to clear the cover. ⛔ The empty string is the CLEAR rather than `null`, so there is exactly one spelling of "no cover".

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

PATCH /v1/agency/boards/{boardId}/cards/{cardId}