agency-board

POST `/v1/agency/boards/{boardId}/invites`

Mint a copy-paste link to this board.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/invites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Returns a link you can paste into anything — a chat, an email you write yourself, a document. **No email is sent by us**, which is the point. A `viewer` link is read-only and needs **no Zinn® account**: whoever opens it sees exactly what the client sees, and can write nothing. Any other role seats the person on the board and therefore requires them to sign in first. ⛔ `token` appears in **this response only**. It cannot be read back later. ⛔ For a seat-bearing role this refuses unless the caller could grant that seat's organisation role themselves. The check has to happen here rather than at redemption, because by then the person redeeming is a stranger and there is no principal whose privileges could bound the grant.

参数

名称	类型	必填	内容简介
`boardId (path)`	`Uuid`	是	Project board ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`role`	`AgencyBoardInviteRole`	否	—
`label`	`string`	否	—
`expires_in_days`	`integer`	否	—
`max_uses`	`integer`	否	Omit for an unlimited link.

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`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…
`token`	`string`	否	The full link token. ⛔ Present on the create response and NOWHERE ELSE. Only its SHA-256 digest is stored, so nothing can re-derive it — a screen that needs it must keep it…
`token_prefix`	`string`	是	The first few characters, so a manager with three links open can tell them apart. Far too short to shorten the search space of the secret part.
`label`	`string`	否	A note the manager typed. Never shown to the recipient.
`member_org_id`	`string`	否	The organisation a seat from this link belongs to. `null` for `viewer`, which seats nobody.
`expires_at`	`string`	是	When the link stops admitting new people. ⛔ Expiry does not evict anybody who already joined — a colleague who joined in March must not lose the board in April because the s…
`max_uses`	`integer`	否	`null` is unlimited. `1` makes the link single-use.
`uses`	`integer`	是	Seats created through this link. A repeat visit by somebody already on the board does not count, so a client who bookmarks the link cannot exhaust it.
`revoked_at`	`string`	否	—
`last_used_at`	`string`	否	—
`created_at`	`string`	是	—
`is_live`	`boolean`	是	Whether the link may admit somebody new right now — not revoked, not expired, not exhausted. Computed, so a caller never has to re-implement all three conditions.

此端点可能返回的错误

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/invites