员工批量修改接口-钉版

业务场景

该接口用于批量更新员工。只适用于钉版环境的公司

接口限制

 1. 10次/秒;
 2. 单次导入限制为200条数据;

接口说明

1. 单条失败模式。即传入的每条数据互不影响。某条失败,不会影响其他数据执行。

接口地址

员工批量同步接口

/api/openapi/employee/dingTalk/batch

请求类型

POST

请求参数

参数说明

字段名称 字段类型 是否必填 字段说明
employeeId String(50) 员工工号
email String(50) 工作邮箱,
工作邮箱和工作手机号至少填写一个。
若该参数当前有值,传""、null视为清除原数据。
不填时视为维持原数据。
phoneNo String(50) 工作手机号,
工作邮箱和工作手机号至少填写一个。
若该参数当前有值,传""、null视为清除原数据。
不填时视为维持原数据。
请按照“+国际区号”“手机号”格式写入,如+8615700115928,以确保写入的数据正确。
employeeNickName String(50) 员工花名,
不填时视为维持原数据
填写空字符串时视为清除原数据
roleNames List<String> 员工角色名称,具体见设置页面‘角色与权限-角色名称’,
不填时视为维持原数据
填写空数组时视为清除原数据
residences List<PlaceInfo> 常驻地,
不填时视为维持原数据
填写空数组时视为清除原数据
customObject CustomObject 员工的自定义字段,
不填时视为维持原数据
填写空对象时视为清除原数据
updateCustomObject boolean 是否对传入的和已经存在的CustomObject进行比对, 否:不比对, 是:比对,更新比对匹配的, 没匹配的保留. 默认false
hireDate String (50) 入职日期。格式yyyy-MM-dd。
不填时视为维持原数据
填写空字符串时视为清除原数据
defaultLegalEntityBizCode String (50) 默认公司编码,
不填时视为维持原数据
填写空字符串时视为清除原数据
classPositionBizCode String(50) 职级编码,
不填时视为维持原数据
填写空字符串时视为清除原数据
idInfo List<IdInfo> 证件信息,
不填时视为维持原数据
填写空数组时视为清除原数据
enName EnName 英文名,
不填时视为维持原数据
gender String(10) 性别,可填写MAN(男),WOMAN(女),
不填时视为维持原数据
填写空字符串时视为清除原数据

PlaceInfo参数说明:

字段名 类型 是否必填 字段说明
placeCode String 地址代码,如“330101”,见每刻地址库

IdInfo参数说明:

字段名 类型 是否必填 字段说明
idType String 证件类型,可选值
ID_CARD(身份证),
GATResidencePermit(港澳台居民居住证),
WGRResidenceIdCard(外国人永久居留身份证),
GATMainlandPass(港澳居民来往内地通行证),
TAIWAN_TravellingPass(台湾居民来往大陆通行证),
Protection(护照)
idNumber String 证件号码

EnName参数说明:

字段名 类型 是否必填 字段说明
firstName
String First Name
middleName String Middle Name
lastName String Last Name

参数样例

[
  {
    "employeeId": "E10001",
    "email": "luo1@maycur.com",
    "phoneNo": "12345678901",
    "employeeNickName": "花名",
    "roleNames": [
      "luo@maycur.com"
    ],
    "residences": [
      {
        "placeCode": "330101"
      }
    ],
    "customObject": {
      "CF1395": 1,
      "CF1396": {
        "currencyCode": "CNY",
        "amount": "1.00"
      },
      "CF1397": {
        "currentTime": 1566204741186
      }
    }
  }
]

响应参数

参数样例

  1. 正常响应参数示例
{
  "success": true,
  "code": "ACK",
  "message": "保存成功!",
  "data": null
}
  1. 错误返回示例
{
  "success": false,
  "code": "NACK",
  "message": "",
  "data": {
    "errorData": [
      {
        "key": "E10001",
        "errorCode": "110001",
        "errorMessage": "找不到对应的员工"
      }
    ]
  }
}

errorData中的errorCode说明

错误码说明

修改记录

2023-04-25 新增
Copyright © 杭州每刻科技有限公司 www.maycur.com all right reserved,powered by Gitbook该文件修订时间: 2025-08-11 10:03:37

results matching ""

    No results matching ""

    results matching ""

      No results matching ""