agency-board

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

Create or replace a named cut of the board.

Tutti gli endpoint agency-board

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

NomeTipoObbligatorioChe cos'è
boardId (path)UuidProject board ID (UUIDv7).

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
namestring
definitionAgencyBoardViewDefinitionNoThe 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_defaultbooleanNo

Risposta

NomeTipoObbligatorioChe cos'è
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestring
definitionAgencyBoardViewDefinitionThe 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_defaultbooleanWhat a member sees on opening this board cold. At most one per board.
created_atstringNo

Errori che questo endpoint può restituire

401 · 403 · 404 · 422