public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
shareToken (path) | string | Ya | 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… |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
joined | boolean | Ya | — |
seated | boolean | Tidak | Whether this call created the seat, as opposed to returning an existing one. |
role | AgencyBoardInviteRole | Tidak | 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 | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | Tidak | — |
detail | string | Tidak | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 404 · 410 · 422