agency-board

POST /v1/agency/boards

Create a project board.

All agency-board endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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

Creates the board **and a working default pipeline** — Requests · Backlog · In progress · Review · Done — with *Requests* marked as the client intake column and *Requests*, *In progress* and *Done* already client-visible. ⛔ Not a placeholder (§2.41): the board is usable by an agency and by its client the moment it exists, rather than after a configuration step nobody documents. Requires the `agency_project_board` entitlement on the acting org.

Request body

NameTypeRequiredWhat it is
namestringYes
descriptionstringNo
org_idstringNo
client_org_idstringNo

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesThe agency that owns this board.
client_org_idstringNoThe 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_namestringNoThat 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…
namestringYes
descriptionstringNo
archived_atstringNo
open_question_countintegerNo
created_atstringYes
updated_atstringNo
created_byAgencyBoardActorNoWho created the board. `null` if that account no longer exists.
updated_byAgencyBoardActorNoWho 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…

Errors this endpoint can return

401 · 403 · 422