agency-board

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

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

All agency-board endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.

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 PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/columns/{columnId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⛔ 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.

Parameters

NameTypeRequiredWhat it is
boardId (path)UuidYesProject board ID (UUIDv7).
columnId (path)UuidYesBoard column ID (UUIDv7).

Request body

NameTypeRequiredWhat it is
namestringNo—
visibilityAgencyBoardVisibilityNoWho 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…
wip_limitintegerNo—
positionintegerNo—
is_intakebooleanNo—

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringYes—
positionintegerYes—
visibilityAgencyBoardVisibilityYesWho 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…
is_intakebooleanYesThe single column a client may raise a request in. At most one per board.
wip_limitintegerNoAdvisory 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.

Errors this endpoint can return

401 · 403 · 404 · 422