agency-board

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

Ask the client a question about this card.

All agency-board endpoints

All developer docs →

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}/questions \
  -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

⛔⛔ Asking a question SHARES the card, and its column, in the same transaction — explicitly, and written to the board's activity feed so the agency can see it happened. A question the client is expected to answer, on a card they cannot open, is a state no screen can render: the client would be emailed a link to nothing. Notifies the client organisation (agency_board.question_asked).

Parameters

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

Request body

NameTypeRequiredWhat it is
bodystringYes—

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
card_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
bodystringYes—
statusstring<open, answered, cancelled>Yes—
answer_bodystringNo—
answered_atstringNo—
created_atstringYes—
asked_byAgencyBoardActorNo—
answered_byAgencyBoardActorNo—

Errors this endpoint can return

401 · 403 · 404 · 422