agency-board

PATCH /v1/agency/boards/{boardId}/columns/{columnId}

Rename a column, change what the client sees, or make it the intake column.

すべての agency-board エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/columns/{columnId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

⛔ Setting `visibility` to `internal` hides **every card in the column** from the client at once, by the AND rule — nothing is rewritten on the cards, so setting it back to `client` restores exactly the previous state rather than a guess at it. `is_intake: true` moves the client's "raise a request" column here; at most one column per board holds it, and the previous one is cleared in the same transaction.

パラメータ

名前タイプ必須これがその内容です
boardId (path)UuidはいProject board ID (UUIDv7).
columnId (path)UuidはいBoard column ID (UUIDv7).

リクエスト本文

名前タイプ必須これがその内容です
namestringいいえ
visibilityAgencyBoardVisibilityいいえ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 th…
wip_limitintegerいいえ
positionintegerいいえ
is_intakebooleanいいえ

返信

名前タイプ必須これがその内容です
idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringはい
positionintegerはい
visibilityAgencyBoardVisibilityはい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 th…
is_intakebooleanはいThe single column a client may raise a request in. At most one per board.
wip_limitintegerいいえAdvisory only, shown in the UI. ⛔ It never refuses a move: a WIP limit that blocks work turns a management convention into an outage on a Friday evening.

このエンドポイントが返すエラー

401 · 403 · 404 · 422