agency-board

POST `/v1/agency/client/boards/{boardId}/cards/{cardId}/comments`

Comment on a shared card.

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/client/boards/{boardId}/cards/{cardId}/comments \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "body": <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

The card is looked up through the same filter the read uses, so a client cannot comment on a card they cannot see — including by guessing its id. A client's comment is always visible to them and to the agency.

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
`body`	`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).
`body`	`string`	Yes	—
`from_client`	`boolean`	No	—
`created_at`	`string`	Yes	—
`author_label`	`string`	No	Who wrote it, as the client may see it — the agency's organisation name for anything the agency wrote, the person's name for the client's own colleagues. Same ruling as `SharedA…

Errors this endpoint can return

401 · 403 · 404 · 422

POST /v1/agency/client/boards/{boardId}/cards/{cardId}/comments