public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
shareToken (path) | string | Иә | 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… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
joined | boolean | Иә | — |
seated | boolean | Жоқ | Whether this call created the seat, as opposed to returning an existing one. |
role | AgencyBoardInviteRole | Жоқ | 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 | Иә | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
membership_id | string | Жоқ | — |
detail | string | Жоқ | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 404 · 410 · 422