agency-board

POST /v1/agency/boards/{boardId}/cards/{cardId}/restore

Take a card back out of the archive.

All agency-board endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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 POST https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/restore \
  -H "Authorization: Bearer zdk_live_…"

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

⛔ A separate operation rather than `PATCH {"archived_at": null}`, because `archived_at` is a timestamp the server owns: a caller who may write it may also write a date in 2031, and the position reindex that has to happen alongside it would not. The card returns at the END of its column — the position it held was reindexed away when it was archived, and the bottom is where a person looks for something they have just restored.

Parameters

NameTypeRequiredWhat it is
boardId (path)UuidYesProject board ID (UUIDv7).
cardId (path)UuidYesBoard card ID (UUIDv7).

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
column_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringYes
bodystringNo
visibilityAgencyBoardVisibilityYesWho 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…
positionintegerYes
assignee_idstringNo
due_atstringNo
created_by_clientbooleanNoWhether the client raised this card themselves.
archived_atstringNo
cover_colourAgencyBoardLabelColourNoA 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…
labelsAgencyBoardLabel[]NoThe 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_atstringNo
updated_atstringNo

Errors this endpoint can return

401 · 403 · 404