更新人员组成员

更新指定人员组成员。

Tip: 该接口更新模式为覆盖式更新，更新操作会清除人员组以前的成员。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/performance/v2/user_group_user_rels/write
HTTP Method	POST
接口频率限制	20 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	performance:semester_activity:write 管理周期与项目配置信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
client_token	string	是	根据 client_token 是否一致来判断是否为同一请求 示例值：123456 数据校验规则： - 长度范围：0 ～ 64 字符
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - people_admin_id: 以people_admin_id来识别用户 默认值：open_id 数据校验规则： - 长度范围：0 ～ 999999999 字符 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
group_id	string	否	人员组 ID，可以从人员组管理页面获取 必填： 是 示例值："ABCDEFG" 数据校验规则： - 长度范围：0 ～ 128 字符
scope_visible_setting	int	否	人员组可见性配置 必填： 是 示例值：1 可选值有： - 0: 无限制 - 1: 后台管理员不可见 默认值：1 数据校验规则： - 取值范围：0 ～ 10
user_ids	string\[\]	否	人员 ID 列表，ID 类型与查询参数 user_id_type 取值一致 必填： 是 示例值：["ou_fab1210511b6d2f990ba3b4e2e0dbeef"] 数据校验规则： - 长度范围：0 ～ 10000

请求体示例

{
    "group_id": "ABCDEFG",
    "scope_visible_setting": 1,
    "user_ids": [
        "ou_fab1210511b6d2f990ba3b4e2e0dbeef"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ data	write_user_group_scope_data	更新结果
└ success_user_ids	string\[\]	更新成功的员工 ID 列表，与入参 user_id_type 类型一致
└ fail_user_datas	write_user_group_scope_fail_user_data\[\]	更新失败的员工信息
└ user_id	string	员工 ID，与入参 user_id_type 类型一致
└ fail_code	int	失败原因枚举 可选值有： - 1: 员工未找到

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "data": {
            "success_user_ids": [
                "ou_a9dc8d009fd5395c22c7e040e0130692"
            ],
            "fail_user_datas": [
                {
                    "user_id": "ou_ff77dba046431fc53ea21a0095df82f4",
                    "fail_code": 1
                }
            ]
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1580101	internal error	请根据实际报错信息定位或咨询技术支持
400	1580102	param is invalid	检查参数是否正确，例如类型，大小
400	1580401	user group not support api import	请联系企业管理员前往绩效系统「后台配置」检当前人员组的「人员范围设置」-「设置方式」是否勾选为「API 自动写入人员名单」选项
400	1580402	user group has running import task	有其它更新人员组成员任务正在执行，请稍后重试
400	1580403	scope over limit	更新的人员组成员数量超过限制，请咨询技术支持
400	1580110	request ID repeat	client_token 重复，请检查 client_token 入参是否正确

更多错误码信息，参见通用错误码。