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