agency-board
POST /v1/agency/boards/{boardId}/views
Create or replace a named cut of the board.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
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 POST https://api.zinndigital.com/v1/agency/boards/{boardId}/views \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'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
Details
⛔ 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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
definition | AgencyBoardViewDefinition | No | The 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_default | boolean | No | — |
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 | — |
definition | AgencyBoardViewDefinition | Yes | The 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_default | boolean | Yes | What a member sees on opening this board cold. At most one per board. |
created_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422