API 参考/人员管理/邀请成员
邀请成员
更新于: 2026-06-11 19:19:28
邀请成员
邀请指定人员加入企业。该操作会向被邀请人发送邮件，需注意风险。
所需权限
users:write
请求方式
POST /openapi/v1/users/invite
请求体
|
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
|
|
array |
是 |
待邀请成员，最多 20 个。 |
users[] 对象包含以下参数：
|
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
|
|
string |
是 |
待邀请成员的邮箱地址。 |
|
|
string |
是 |
待邀请成员的角色：
|
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
|
int |
成功邀请的成员数量。 |
|
|
array |
邀请失败的成员列表。 |
failed_items[] 数组包含以下参数：
|
参数 |
类型 |
描述 |
|---|---|---|
|
|
string |
邀请失败的成员邮箱（即请求中传入的原始值）。 |
|
|
int |
错误码。 |
|
|
string |
失败原因。 |
请求示例
{
"users": [
{ "email": "alice@example.com", "role": "admin" },
{ "email": "bob@example.com", "role": "member" }
]
}
响应示例
{
"code": 0,
"message": "success",
"request_id": "req_abc123xyz",
"data": {
"success_count": 2,
"failed_items": [
{
"email": "exists@example.com",
"code": 30001,
"message": "user already exists in this tenant"
}
]
}
}