agency-board
POST /v1/agency/boards/{boardId}/cards/{cardId}/checklist
Append one line to the card's checklist.
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 POST https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/checklist \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "text": <string> }'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 checklist has no visibility of its own — it inherits the card's. A client shown "3 of 7 done" over a list whose four hidden items they cannot see is a progress figure that does not match its own list, which reads as a bug.
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 |
|---|---|---|---|
text | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
text | string | Yes | — |
position | integer | Yes | — |
done_at | string | No | When it was ticked. null means outstanding. |
done_by | AgencyBoardActor | No | Who ticked it. ⛔ Kept when the item is un-ticked as well, so "Sam ticked this and then un-ticked it" stays answerable. |
created_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422