WorkspaceWorkspaceInvites

邀请用户

向提供的邮箱发送加入工作区的邀请邮件。如果用户没有账户，系统会提示其创建账户。如果用户接受邀请，将使用一个席位添加为工作区和订阅的用户。此端点仅可由拥有 WORKSPACE_MEMBERS_INVITE 权限的工作区成员调用。如果用户已在工作区中，将返回 400 错误。

请求头

xi-api-keystring可选

请求

This endpoint expects an object.
emailstring必需

客户邮箱

seat_typeenum or null可选

用户的席位类型

允许的值:
group_idslist of strings or null可选

用户的群组 ID

usage_limitinteger or null可选>=0

受邀者的每月积分使用上限。省略或设为 null 则不设置自定义上限。

workspace_permissionstring or null可选Deprecated

用户的工作区权限。此字段已弃用，请改用 seat_type。

响应

成功响应

statusstring

工作区邀请请求的状态。如果请求成功，状态将为 ‘ok’。否则将返回状态为 500 的错误消息。

错误

422
Unprocessable Entity Error