创建员工 - 探马OpenAPI

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

salesId

string

成员ID。

可选

对应管理端的帐号，企业内必须唯一。长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。

name

string

成员名称。

必需

长度为1~64个utf8字符

alias

string

成员别名。

可选

长度1~64个utf8字符

mobile

string

手机号码。

可选

企业内必须唯一，mobile/email二者不能同时为空

department

array[integer]

成员所属部门id列表

必需

不超过100个

email

string

邮箱。

可选

长度6~64个字节，且为有效的email格式。企业内必须唯一，mobile/email二者不能同时为空

is_leader_in_dept

array[integer]

表示在所在的部门内是否为部门负责人。

可选

个数必须和参数department的个数一致，表示在所在的部门内是否为部门负责人。1表示为部门负责人，0表示非部门负责人。在审批等应用里可以用来标识上级审批人

to_invite

boolean

是否邀请该成员使用企业微信

可选

将通过微信服务通知或短信或邮件下发邀请，每天自动下发一次，最多持续3个工作日，默认值为true。

示例

{
    "salesId": "lisi12345666",
    "name": "李四",
    "alias": "jackli",
    "mobile": "13866666677",
    "department": [
        17133,
        17134
    ],
    "email": "lisi12345@gzdev.com",
    "isLeaderInDept": [
        1,
        1
    ],
    "toInvite": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/create-staff' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "salesId": "lisi12345666",
    "name": "李四",
    "alias": "jackli",
    "mobile": "13866666677",
    "department": [
        17133,
        17134
    ],
    "email": "lisi12345@gzdev.com",
    "isLeaderInDept": [
        1,
        1
    ],
    "toInvite": true
}'

返回响应

🟢200成功

application/json

Body

code

integer

示例：0

必需

message

string

必需

示例：success

示例

{
    "code": 0,
    "message": "success"
}

⚪-1错误