agency-board

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

Rename a board or attach a client organisation to it.

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} \
  -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

Detalhes

Attaching a client to a board that has none is always allowed — that is how a board created for internal work becomes a client's board. ⛔ **Changing or clearing a client that is already attached is refused with a `422` once the client has seen anything on the board** — a client-visible card, a question asked of them, or one of their people invited to it. Re-pointing such a board would hand a second client the first one's brief, answers and complaints through a screen whose whole promise is that a client sees only what the agency shared. Archive the board and start a new one for the other client. Sending the client id the board already holds is not a change and is never refused, so a rename carrying the whole form still works.

Parâmetros

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

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Não	—
`description`	`string`	Não	—
`client_org_id`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Sim	The agency that owns this board.
`client_org_id`	`string`	Não	The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim…
`client_org_name`	`string`	Não	That client organisation's name, resolved by the engine. `client_org_id` set with this `null` is a real state and not an error — the board names a client the caller may not read…
`name`	`string`	Sim	—
`description`	`string`	Não	—
`archived_at`	`string`	Não	—
`open_question_count`	`integer`	Não	—
`created_at`	`string`	Sim	—
`updated_at`	`string`	Não	—
`created_by`	`AgencyBoardActor`	Não	Who created the board. `null` if that account no longer exists.
`updated_by`	`AgencyBoardActor`	Não	Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when `upda…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}