agency-board

POST /v1/agency/boards/{boardId}/views

Create or replace a named cut of the board.

Todos os endpoints de agency-board

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

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

⛔ Server-side rather than per-browser, because the value of a saved view is that the whole team opens the same one — on a second laptop, on a phone, and after a browser reset. ⭐ Upsert by name: saving over a view you already have is what a person means by pressing Save with the same name, and a uniqueness error there is a dead end with no remedy in a UI. Unknown keys in `definition` are DROPPED rather than refused, so a newer console and an older engine can coexist during a deploy.

Parâmetros

NomeTipoObrigatórioO que é
boardId (path)UuidSimProject board ID (UUIDv7).

Corpo da requisição

NomeTipoObrigatórioO que é
namestringSim
definitionAgencyBoardViewDefinitionNãoThe filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against…
is_defaultbooleanNão

Resposta

NomeTipoObrigatórioO que é
idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringSim
definitionAgencyBoardViewDefinitionSimThe filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against…
is_defaultbooleanSimWhat a member sees on opening this board cold. At most one per board.
created_atstringNão

Erros que este endpoint pode retornar

401 · 403 · 404 · 422