agency-board
POST /v1/agency/boards/{boardId}/cards/{cardId}/questions
Ask the client a question about this card.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔⛔ **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`).
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
boardId (path) | Uuid | はい | Project board ID (UUIDv7). |
cardId (path) | Uuid | はい | Board card ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
body | string | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
card_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
body | string | はい | — |
status | string<open, answered, cancelled> | はい | — |
answer_body | string | いいえ | — |
answered_at | string | いいえ | — |
created_at | string | はい | — |
asked_by | AgencyBoardActor | いいえ | — |
answered_by | AgencyBoardActor | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422