# 更新用户所有信息

该接口用于更新通讯录中用户的字段。

  • 注意： 应用需要拥有待更新用户的通讯录授权，如果涉及到用户部门变更，还需要同时拥有变更前、后所有新部门的通讯录授权。

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/contact/users/:user_id
HTTP Method PUT
支持的应用类型 仅自建应用
权限要求 更新通讯录
字段权限要求 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户基本信息
获取用户 user_id
获取用户邮箱
获取用户性别
获取用户手机号
获取用户雇佣信息
获取用户组织架构信息

# 请求头

名称 类型 必填 描述
Authorization string 是 tenant_access_token
值格式："Bearer access_token"
示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 是 固定值："application/json; charset=utf-8"

# 路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称 类型 描述
user_id string 用户ID，需要与查询参数中的user_id_type类型保持一致。
示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"

# 查询参数

名称 类型 必填 描述
user_id_type string 否 用户 ID 类型
示例值："open_id"
可选值有：
* open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
* union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。
* user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。
默认值：open_id
当值为 user_id，
字段权限要求：
获取用户 user ID

# 请求体

名称 类型 必填 描述
name string 是 用户名
字段权限要求（满足任一）：
获取用户基本信息
nickname string 否 别名
字段权限要求（满足任一）：
获取用户基本信息
email string 是 邮箱，在本企业内不可重复。
字段权限要求：
获取用户邮箱信息
mobile string 是 手机号，在本企业内不可重复。
字段权限要求：
获取用户手机号
gender int 否 性别
可选值有：
* 0：保密
* 1：男
* 2：女
字段权限要求（满足任一）：
获取用户性别
avatar_key string 否 用户头像信息
字段权限要求（满足任一）：
获取用户基本信息
department_id string 是 用户所属部门的ID。
字段权限要求（满足任一）：
获取部门基础信息
deputy_department_id string[] 否 兼职部门ID
lateral_user_ids string[] 否 次级汇报人Id
join_time string 否 入职时间
leave_time string 否 离职时间
participatework_time string 否 参加工作时间
employee_type string 否 员工类型
可选值有：
* REGULAR：正式
* PROBATIONARY：试用
report_user_id string 否 汇报人userId。
字段权限要求（满足任一）：
获取用户 user_id
job_title string 否 职务
字段权限要求（满足任一）：
获取用户组织架构信息
work_station string 否 工位
custom_attr custom_attr[] 否 自定义字段
 ∟field_name string 是 字段名称
 ∟field_value string 否 字段值

# 请求体示例

{
    "name": "开放平台部分更新1",
    "nickname": "测试1",
    "email": "123333333391@kanzhun.com",
    "mobile": "12312341222",
    "gender": 2,
    "avatar_key": "http://img.bosszhipin.com/v2/upload/ship/avatar/male-3.png",
    "department_id": "org05091245",
    "deputy_department_ids": ["1KZerI5GhivqYwHn2"],
    "lateral_user_ids": ["11111111392"],
    "join_time": "2022-01-01 01:01:02",
    "leave_time": "2022-01-01 01:01:02",
    "participatework_time": "2022-01-01 01:01:02",
    "employee_type": "PROBATIONARY",
    "job_title": "开发",
    "report_user_id": "11111111394",
    "work_station": "北京",
    "custom_attr": [{
        "filed_name":"db24318acfc24ab8965084d2504aafb3",
        "field_value":"2023-01-24T16:00:01.000Z"
    }]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 响应

# 响应体

名称 类型 描述
code int 错误码，非 0 表示失败
msg string 错误描述
data - -
 ∟ open_id string 开放平台唯一Id，标识一个用户在某个应用中的身份
 ∟ union_id string 标识一个用户在某个应用开发商下的身份
 ∟ user_id string 租户内用户的唯一标识，用户的user_id
字段权限要求：
获取用户 user_id（仅自建应用）
 ∟ name string 用户名
字段权限要求（满足任一）：
获取用户基本信息
 ∟ nickname string 别名
字段权限要求（满足任一）：
获取用户基本信息
 ∟ email string 邮箱，注意非 +86 手机号成员必须同时添加邮箱
字段权限要求：
获取用户邮箱信息
 ∟ mobile string 手机号，在本企业内不可重复；未认证企业仅支持添加中国大陆手机号，注意国际电话区号前缀中必须包含加号 +
字段权限要求：
获取用户手机号
 ∟ gender int 性别
可选值有：
* 0：保密
* 1：男
* 2：女
字段权限要求（满足任一）：
获取用户性别
 ∟ avatar_key string 用户头像信息
字段权限要求（满足任一）：
获取用户基本信息
 ∟ status user_status 用户状态
字段权限要求（满足任一）：
获取用户雇佣信息
  ∟is_resigned boolean 是否离职
  ∟is_activated boolean 是否激活
 ∟department_ids string[] 用户所属部门的ID列表，一个用户可属于多个部门，主部门在第一个。
字段权限要求（满足任一）：
获取部门基础信息
 ∟ leader_user_id string 用户的直接主管的用户ID，
字段权限要求（满足任一）：
获取用户 user_id
 ∟lateral_user_ids string[] 次级汇报人Id
 ∟join_time string 入职时间
 ∟leave_time string 离职时间
 ∟participatework_time string 参加工作时间
 ∟employee_type string 员工类型
可选值有：
* REGULAR：正式
* PROBATIONARY：试用
 ∟ report_user_id string 汇报人userId。
字段权限要求（满足任一）：
获取用户 user_id
 ∟ employee_no string 工号
字段权限要求（满足任一）：
获取用户组织架构信息
 ∟ job_title string 职务
字段权限要求（满足任一）：
获取用户组织架构信息
 ∟work_station string 工位
 ∟custom_attrs custom_attr[] 自定义字段
  ∟field_name string 字段名称
  ∟field_value string 字段值
  ∟type string 字段类型
可选值有：
* TEXT：文本
* WEB：网页
* DOWN_SINGLE：下拉单选
* DOWN_MULTIPLE：下拉多选
* DATE：日期
* DATE_INTER：日期区间
* STAFF_SINGLE：人员单选
* STAFF_MULTIPLE：人员多选
* DEPT_SINGLE：部门单选
* DEPT_MULTIPLE：部门多选
  ∟field_desc string 字段描述

# 响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "success": true,
    "data": {
        "union_id": "on_1a036c7ea57bb88ab8997333fbe9521a",
        "user_id": "zWSpL1oqHztPVrld",
        "open_id": "ou_ee3d10d47501b8ed260b8e06220787b7",
        "name": "开放平台部分更新1",
        "nickname": "kai fang ping tai bu fen geng xin 1",
        "email": "123333333391@kanzhun.com",
        "mobile": "12312341222",
        "gender": 2,
        "avatar_key": "http://img.bosszhipin.com/v2/upload/ship/avatar/male-4.png",
        "status": {
            "is_resigned": false,
            "is_activated": false
        },
        "department_ids": [
            "org05091245",
            "1KZerI5GhivqYwHn2"
        ],
        "leader_user_id": "11111111287",
        "lateral_user_ids": [
            "11111111392"
        ],
        "employee_no": "zWSpL1oqHztPVrld",
        "job_title": "开发",
        "report_user_id": "11111111394",
        "icon": "http://img.bosszhipin.com/v2/upload/ship/avatar/male-4.png",
        "join_time": "2022-01-01 01:01:02",
        "leave_time": "2022-01-01 01:01:02",
        "participatework_time": "2022-01-01 01:01:02",
        "employee_type": "PROBATIONARY",
        "work_station": "北京",
        "custom_attrs": [
            {
                "type": "DATE",
                "fieldName": "db24318acfc24ab8965084d2504aafb3",
                "fieldValue": "2023-01-24T16:00:01.000Z",
                "fieldDesc": "佳佳测试"
            }
        ]
    },
    "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
最后更新于 : 3/4/2024, 3:29:16 PM

← 创建部门 →