members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

所有 members 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 members.invite 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

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

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

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

详细信息

Invites an email (the person need not exist yet — users are Keycloak subjects) to join with a role. The role is validated to be one the inviter is themselves permitted to grant: a role holding any permission the inviter lacks in that organization is refused (422), so members.invite is not a ladder to owner. A re-invite of the same email refreshes the pending invite. Emits member.invited so the invitation email is sent. Requires members.invite in the target org.

请求正文

名称	类型	必填	内容简介
`email`	`string`	是	—
`role`	`string`	是	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	否	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

响应

名称	类型	必填	内容简介
`id`	`string`	是	—
`org_id`	`string`	是	—
`org_name`	`string`	是	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	是	—
`role`	`string`	是	—
`site_grants`	`object[]`	是	The individual sites this invitation lends, when it was created by sharing a site with an address that had no account (`POST /v1/sites/{siteId}/collaborators`). Empty for an…
`status`	`string<pending, accepted, revoked>`	是	—
`expires_at`	`string`	是	—
`accepted_at`	`string`	否	—
`created_at`	`string`	是	—

此端点可能返回的错误

401 · 403 · 422 · 429