public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Autentifikacija
Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
shareToken (path) | string | Da | 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… |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
joined | boolean | Da | — |
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 | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | Ne | — |
detail | string | Ne | — |
Pogreške koje ova krajnja točka može vratiti
401 · 404 · 410 · 422