更新部门

POST

http://127.0.0.1/topapi/v2/department/update

服务端API/通讯录管理/部门管理

最后修改时间：2022-08-30 09:19:22

责任人：未设置

说明

调用本接口更新部门信息。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

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

请求参数

Query 参数

access_token

string

必需

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

示例值:

bE74xxxx

Body 参数application/json

dept_id

number

部门ID。

必需

parent_id

number

可选

父部门ID，根部ID为1。

hide_dept

boolean

可选

是否隐藏本部门：true：隐藏部门隐藏后本部门将不会显示在公司通讯录中。false：显示部门不传值，则保持不变。

dept_permits

string

可选

指定可以查看本部门的其他部门列表。当hide_dept为true时，则此值生效。该参数列表总数和user_permits列表总数之和不能超过50。

user_permits

string

可选

指定可以查看本部门的用户userid列表。当hide_dept为true时，则此值生效。该参数列表总数和dept_permits列表总数之和不能超过50。

create_dept_group

boolean

可选

是否创建一个关联此部门的企业群，默认为false即不创建。不传值，则保持不变。

order

number

可选

在父部门中的排序值，order值小的排序靠前。

name

string

可选

部门名称，长度限制为1~64个字符，不允许包含字符‘-’‘，’以及‘,’。

source_identifier

string

可选

部门标识字段，开发者可用该字段来唯一标识一个部门，并与钉钉外部通讯录里的部门做映射。

outer_dept

boolean

可选

是否限制本部门成员查看通讯录：true：开启限制。开启后本部门成员只能看到限定范围内的通讯录false：不限制不传值，则保持不变。

outer_permit_users

string

可选

指定本部门成员可查看的通讯录用户userid列表。当outer_dept为true时，此参数生效。该参数列表总数和outer_permit_depts列表总数之和不能超过50。

outer_permit_depts

string

可选

指定本部门成员可查看的通讯录部门ID列表。当outer_dept为true时，此参数生效。该参数列表总数和outer_permit_users列表总数之和不能超过50。

outer_dept_only_self

boolean

可选

本部门成员是否只能看到所在部门及下级部门通讯录：true：只能看到所在部门及下级部门通讯录false：不能查看所有通讯录，在通讯录中仅能看到自己当outer_dept为true时，此参数生效。不传值，则保持不变。

language

string

可选

通讯录语言：zh_CN：中文en_US：英文

auto_add_user

boolean

可选

当部门群已经创建后，有新人加入部门时是否会自动加入该群：true：自动加入群false：不会自动加入群不传值，则保持不变。

auto_approve_apply

boolean

可选

是否默认同意加入该部门的申请：true：表示加入该部门的申请将默认同意false：表示加入该部门的申请需要有权限的管理员同意

dept_manager_userid_list

string

可选

部门的主管userid列表，多个userid之间使用英文逗号分隔。

group_contain_sub_dept

boolean

可选

部门群是否包含子部门：true：包含false：不包含不传值，则保持不变。

group_contain_outer_dept

boolean

可选

部门群是否包含外包部门：true：包含false：不包含不传值，则保持不变。

group_contain_hidden_dept

boolean

可选

部门群是否包含隐藏部门：true：包含false：不包含不传值，则保持不变。

org_dept_owner

string

可选

企业群群主的userid。

force_update_fields

string

可选

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

示例

{
  "dept_permits": "123,456",
  "outer_permit_users": "user123,manager123",
  "group_contain_outer_dept": true,
  "org_dept_owner": "100",
  "outer_dept": true,
  "language": "zh_CN",
  "source_identifier": "HR部门",
  "group_contain_sub_dept": true,
  "auto_add_user": false,
  "dept_manager_userid_list": "manager220",
  "parent_id": 2,
  "hide_dept": true,
  "name": "HR",
  "user_permits": "user123,manager222",
  "outer_permit_depts": "123,456",
  "group_contain_hidden_dept": true,
  "outer_dept_only_self": true,
  "dept_id": 100,
  "create_dept_group": true,
  "order": 10
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/v2/department/update?access_token=bE74xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dept_permits": "123,456",
    "outer_permit_users": "user123,manager123",
    "group_contain_outer_dept": true,
    "org_dept_owner": "100",
    "outer_dept": true,
    "language": "zh_CN",
    "source_identifier": "HR部门",
    "group_contain_sub_dept": true,
    "auto_add_user": false,
    "dept_manager_userid_list": "manager220",
    "parent_id": 2,
    "hide_dept": true,
    "name": "HR",
    "user_permits": "user123,manager222",
    "outer_permit_depts": "123,456",
    "group_contain_hidden_dept": true,
    "outer_dept_only_self": true,
    "dept_id": 100,
    "create_dept_group": true,
    "order": 10
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

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

创建部门

删除部门

更新部门

说明#

权限#

请求参数

示例代码

返回响应

说明

权限