agency-board

PATCH `/v1/agency/boards/{boardId}/labels/{labelId}`

Rename or recolour a label.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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}/labels/{labelId} \
  -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

Parameters

Name	Type	Required	What it is
`boardId (path)`	`Uuid`	Yes	Project board ID (UUIDv7).
`labelId (path)`	`Uuid`	Yes	Board label ID (UUIDv7).

Request body

Name	Type	Required	What it is
`name`	`string`	No	—
`colour`	`AgencyBoardLabelColour`	No	⛔ A palette token, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig…

Response

Name	Type	Required	What it is
`id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Yes	—
`colour`	`AgencyBoardLabelColour`	Yes	⛔ A palette token, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig…
`position`	`integer`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/labels/{labelId}