更新用户信息

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

be3Fxxxx

Body 参数application/json

userid

string

必需

员工的userid。

name

string

可选

员工名称，长度最大80个字符。

hide_mobile

boolean

可选

是否号码隐藏：true：隐藏隐藏手机号后，手机号在个人资料页隐藏，但仍可对其发DING、发起钉钉免费商务电话。false：不隐藏

telephone

string

可选

分机号，长度最大50个字符。企业内必须唯一，不可重复

job_number

string

可选

员工工号，长度最大50个字符。

manager_userid

string

可选

直属主管的userId。

title

string

可选

职位，长度最大200个字符。

email

string

可选

员工邮箱，长度最大50个字符。企业内必须唯一，不可重复。

org_email

string

可选

员工的企业邮箱。员工的企业邮箱已开通，才能增加此字段。

org_email_type

string

可选

员工的企业邮箱类型，仅对支持的组织生效（profession: 标准版，base: 基础版）。

work_place

string

可选

办公地点，长度最大100个字符。

remark

string

可选

备注，长度最大2000个字符。

dept_id_list

string

所属部门ID列表。

可选

dept_order_list

array [object {2}]

可选

员工在对应的部门中的排序。

dept_id

number

部门ID。

可选

order

number

可选

员工在部门中的排序。

dept_title_list

array [object {2}]

可选

员工在对应的部门中的职位。

dept_id

number

部门ID。

可选

title

string

可选

员工在部门中的职位。

extension

string

可选

扩展属性，长度最大2000个字符。可以设置多种属性（手机上最多显示10个扩展属性，具体显示哪些属性，可登录OA管理后台>设置>通讯录信息进行设置。该字段的值支持链接类型填写，同时链接支持变量通配符自动替换，目前支持通配符有：userid和corpid。示例：工位地址。

senior_mode

boolean

可选

是否开启高管模式：true：开启。开启后，手机号码对所有员工隐藏。普通员工无法对其发DING、发起钉钉免费商务电话。高管之间不受影响。false：不开启。

hired_date

number

可选

入职时间，UNIX时间戳，单位毫秒。

language

string

可选

通讯录语言，默认zh_CN。如果是英文，请传入en_US。

force_update_fields

string

可选

强制更新的字段，支持清空指定的字段，多个字段之间使用逗号分隔。目前支持字段: manager_userid。

loginId

string

专属帐号登录名。

可选

示例

{
  "extension": {
    "爱好": "旅游",
    "年龄": "24"
  },
  "mobile": "1851302xxxx",
  "telephone": "010-86123456-2345",
  "remark": "备注备注",
  "language": "zh_CN",
  "hide_mobile": "false",
  "title": "技术总监",
  "hired_date": "1597573616828",
  "userid": "zhangsan",
  "work_place": "未来park",
  "dept_title_list": {
    "dept_id": "2",
    "title": "资深产品经理"
  },
  "dept_order_list": {
    "dept_id": "2",
    "order": "1"
  },
  "senior_mode": "false",
  "org_email": "test@xxx.com",
  "name": "张三",
  "dept_id_list": "2,3,4",
  "job_number": "4",
  "email": "test@xxx.com"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1/topapi/v2/user/update?access_token=be3Fxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "extension": {
        "爱好": "旅游",
        "年龄": "24"
    },
    "mobile": "1851302xxxx",
    "telephone": "010-86123456-2345",
    "remark": "备注备注",
    "language": "zh_CN",
    "hide_mobile": "false",
    "title": "技术总监",
    "hired_date": "1597573616828",
    "userid": "zhangsan",
    "work_place": "未来park",
    "dept_title_list": {
        "dept_id": "2",
        "title": "资深产品经理"
    },
    "dept_order_list": {
        "dept_id": "2",
        "order": "1"
    },
    "senior_mode": "false",
    "org_email": "test@xxx.com",
    "name": "张三",
    "dept_id_list": "2,3,4",
    "job_number": "4",
    "email": "test@xxx.com"
}'

返回响应

🟢200成功

application/json

Body

errcode

number

可选

返回码，0代表成功。

errmsg

string

可选

调用失败时返回的错误信息。

示例

{
  "errcode": 0,
  "errmsg": "string"
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限