public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
shareToken (path) | string | Sì | 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… |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
joined | boolean | Sì | — |
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 | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | No | — |
detail | string | No | — |
Errori che questo endpoint può restituire
401 · 404 · 410 · 422