public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
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/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"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
Requires a signed-in person — this is the "one screen from the invite, with the board waiting on the other side" half of the flow. A viewer link needs no join and says so rather than refusing, because a UI offering Join on a read-only link is a UI bug and the honest answer costs one field. Idempotent: somebody already on the board gets their existing seat back and it does not consume one of the link's uses. A client who bookmarks the link and opens it every Monday must not exhaust a 5-use link by themselves.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
shareToken (path) | string | Yes | The share link's bearer token, as it appears in the URL somebody pasted. This is a credential: 256 bits from a CSPRNG behind a zbi_ prefix, and whoever holds it holds the… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
joined | boolean | Yes | — |
seated | boolean | No | Whether this call created the seat, as opposed to returning an existing one. |
role | AgencyBoardInviteRole | No | 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… |
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | No | — |
detail | string | No | — |
Errors this endpoint can return
401 · 404 · 410 · 422