agency-board
POST /v1/agency/boards/{boardId}/invites
Mint a copy-paste link to this 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}/invites \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Returns a link you can paste into anything — a chat, an email you write yourself, a document. No email is sent by us, which is the point. A viewer link is read-only and needs no Zinn® account: whoever opens it sees exactly what the client sees, and can write nothing. Any other role seats the person on the board and therefore requires them to sign in first. ⛔ token appears in this response only. It cannot be read back later. ⛔ For a seat-bearing role this refuses unless the caller could grant that seat's organisation role themselves. The check has to happen here rather than at redemption, because by then the person redeeming is a stranger and there is no principal whose privileges could bound the grant.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
role | AgencyBoardInviteRole | No | — |
label | string | No | — |
expires_in_days | integer | No | — |
max_uses | integer | No | Omit for an unlimited link. |
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). |
role | AgencyBoardInviteRole | Yes | What a share link grants. viewer is link-only: it creates no board seat and no organisation membership, because it grants no identity — it is read-through-the-token, which… |
token | string | No | The full link token. ⛔ Present on the create response and NOWHERE ELSE. Only its SHA-256 digest is stored, so nothing can re-derive it — a screen that needs it must keep it… |
token_prefix | string | Yes | The first few characters, so a manager with three links open can tell them apart. Far too short to shorten the search space of the secret part. |
label | string | No | A note the manager typed. Never shown to the recipient. |
member_org_id | string | No | The organisation a seat from this link belongs to. null for viewer, which seats nobody. |
expires_at | string | Yes | When the link stops admitting new people. ⛔ Expiry does not evict anybody who already joined — a colleague who joined in March must not lose the board in April because the… |
max_uses | integer | No | null is unlimited. 1 makes the link single-use. |
uses | integer | Yes | Seats created through this link. A repeat visit by somebody already on the board does not count, so a client who bookmarks the link cannot exhaust it. |
revoked_at | string | No | — |
last_used_at | string | No | — |
created_at | string | Yes | — |
is_live | boolean | Yes | Whether the link may admit somebody new right now — not revoked, not expired, not exhausted. Computed, so a caller never has to re-implement all three conditions. |
Errors this endpoint can return
401 · 403 · 404 · 422