agency-board
PATCH /v1/agency/boards/{boardId}/cards/{cardId}
Edit a card.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⭐ Sending assignee_id: null unassigns; omitting the field leaves the assignee alone. The two are different requests and the API distinguishes them, because a null-means-absent API cannot express "unassign" at all.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
boardId (path) | Uuid | はい | Project board ID (UUIDv7). |
cardId (path) | Uuid | はい | Board card ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
title | string | いいえ | — |
body | string | いいえ | — |
visibility | AgencyBoardVisibility | いいえ | Who may see this object. internal is always the default. A card reaches the client only when it is client and its column is too — an AND, not inheritance, because that… |
assignee_id | string | いいえ | — |
due_at | string | いいえ | — |
cover_colour | string<neutral, info, violet, ok, warn, crit, > | いいえ | A palette token, or the empty string to clear the cover. ⛔ The empty string is the CLEAR rather than null, so there is exactly one spelling of "no cover". |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
column_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
title | string | はい | — |
body | string | いいえ | — |
visibility | AgencyBoardVisibility | はい | Who may see this object. internal is always the default. A card reaches the client only when it is client and its column is too — an AND, not inheritance, because that… |
position | integer | はい | — |
assignee_id | string | いいえ | — |
due_at | string | いいえ | — |
created_by_client | boolean | いいえ | Whether the client raised this card themselves. |
archived_at | string | いいえ | — |
cover_colour | AgencyBoardLabelColour | いいえ | A colour band across the top of the card, or the empty string for none. ⛔ Shares the label palette rather than declaring a second one: two palettes on one screen is how a cover… |
labels | AgencyBoardLabel[] | いいえ | The labels this card wears, in the board's label order. ⛔ Agency-only — the client's projection of a card carries no labels at all, because a label is the agency's private… |
created_at | string | いいえ | — |
updated_at | string | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422