public
POST /v1/public/boards/shared/{shareToken}/join
Take the seat a share link grants you.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/public/boards/shared/{shareToken}/join \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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