agency-board

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

Put somebody on a board, or invite them by email.

身份验证

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

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/members \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": <string<manager, member, client>> }'

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

详细信息

Give `user_id` for somebody who already has an account, or `email` to invite somebody who does not — the invitation goes through `tenancy.Invitation` and the person joins on acceptance, authenticated by Keycloak with no secret token in the flow. ⛔ A `client` seat may only be given to a member of the board's own client organisation, and **no seat is written for a pending invite**: a client's authorisation is a live membership of that organisation, re-read on every request, so a seat created before acceptance would look like access and confer none.

参数

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

请求正文

名称	类型	必填	内容简介
`user_id`	`string`	否	Somebody who already has an account. Give this or `email`, not both.
`email`	`string`	否	Invite somebody who does not have an account yet.
`role`	`string<manager, member, client>`	是	—
`member_org_id`	`string`	否	Which organisation this seat belongs to. Ignored for a `client` seat, which is always the board's own client organisation.

响应

名称	类型	必填	内容简介
`id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`user_id`	`Uuid`	是	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`member_org_id`	`Uuid`	是	The organisation this seat belongs to — the agency's, or the client's.
`role`	`string<manager, member, client>`	是	—
`last_read_at`	`string`	否	—
`created_at`	`string`	否	—
`user`	`AgencyBoardActor`	否	Who holds this seat, by name. ⛔ Render THIS, never `user_id` — the People drawer printed the id at a colleague's name until 2026-09-01 (`docs/425`).
`invited_by`	`AgencyBoardActor`	否	—

此端点可能返回的错误

401 · 403 · 404 · 422

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