public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
shareToken (path) | string | Ano | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
joined | boolean | Ano | — |
seated | boolean | Ne | Whether this call created the seat, as opposed to returning an existing one. |
role | AgencyBoardInviteRole | Ne | 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 | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | Ne | — |
detail | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 404 · 410 · 422