agency-board
POST /v1/agency/boards/{boardId}/cards/{cardId}/questions
Ask the client a question about this 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/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
| 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 | — |
status | string<open, answered, cancelled> | Yes | — |
answer_body | string | No | — |
answered_at | string | No | — |
created_at | string | Yes | — |
asked_by | AgencyBoardActor | No | — |
answered_by | AgencyBoardActor | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422