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