agency-board

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

Rename or recolour a label.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Parâmetros

Nome	Tipo	Obrigatório	O que é
`boardId (path)`	`Uuid`	Sim	Project board ID (UUIDv7).
`labelId (path)`	`Uuid`	Sim	Board label ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Não	—
`colour`	`AgencyBoardLabelColour`	Não	⛔ 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…

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sim	—
`colour`	`AgencyBoardLabelColour`	Sim	⛔ 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`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

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