文档中心 > API类目 > 钉钉API

dingtalk.oapi.v2.department.update (更新部门)

更新部门

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
dept_id	Number	必须	100		部门ID
parent_id	Number	可选	2		父部门id，根部门id为1
outer_dept	Boolean	可选	true		限制本部门成员查看通讯录，限制开启后，本部门成员只能看到限定范围内的通讯录。true表示限制开启
hide_dept	Boolean	可选	true		是否隐藏部门， true表示隐藏 false表示显示
create_dept_group	Boolean	可选	true	默认值：false	是否创建一个关联此部门的企业群，默认为false
order	Number	可选	10		在父部门中的排序值，order值小的排序靠前
name	String	可选	HR	最大长度：100	部门名称，长度限制为1~100个字符，不允许包含字符‘-’‘，’以及‘,’
source_identifier	String	可选	HR部门		部门标识字段，开发者可用该字段来唯一标识一个部门，并与钉钉外部通讯录里的部门做映射
dept_permits	Number []	可选	3,4,5	最大列表长度：200	可以查看指定隐藏部门的其他部门列表，如果部门隐藏，则此值生效。总数不能超过200。
user_permits	String []	可选	100,200	最大列表长度：200	可以查看指定隐藏部门的其他人员列表，如果部门隐藏，则此值生效，总数不能超过200。
outer_permit_users	String []	可选	500,600	最大列表长度：200	本部门的员工仅可见员工自己为true时，可以配置额外可见人员，userid列表，总数不能超过200。
outer_permit_depts	Number []	可选	6,7,8	最大列表长度：200	本部门的员工仅可见员工自己为true时，可以配置额外可见部门，departmentId列表，总数不能超过200。
outer_dept_only_self	Boolean	可选	true		是否只能看到所在部门及下级部门通讯录
extension	Json	可选	{"姓名":"张三"}		扩展字段，JSON格式
language	String	可选	zh_CN	默认值：zh_CN	通讯录语言
auto_add_user	Boolean	可选	false		如果有新人加入部门是否会自动加入部门群
dept_manager_userid_list	String []	可选	200,300	最大列表长度：999	部门的主管列表，主管的userid列表
group_contain_sub_dept	Boolean	可选	true		部门群是否包含子部门
group_contain_outer_dept	Boolean	可选	true		部门群是否包含外包部门
group_contain_hidden_dept	Boolean	可选	true		部门群是否包含隐藏部门
org_dept_owner	String	可选	100		企业群群主的userid
brief	String	可选	这是简介	最大长度：255	部门简介
telephone	String	可选	138xxxx0000	最大长度：50	部门联系方式
auto_approve_apply	Boolean	可选	true		开启后，加入该部门的申请将默认同意
force_update_fields	String []	可选	dept_manager_userid_list	最大列表长度：999	强制更新的字段，支持清空指定的字段，使用逗号分隔。目前支持字段：dept_manager_userid_list
hide_scene_config	SceneConfig	可选			部门隐藏的生效场景配置
└ active Boolean 可选 true 当前部门是否采用单独的配置。如果设置了false，则采用组织维度的配置 └ profile Boolean 可选 true 是否在个人资料页生效 └ search Boolean 可选 true 是否在搜索生效 └ node_list Boolean 可选 true 是否在查看组织架构生效 └ chatbox_subtitle Boolean 可选 true 是否在单聊框生效
outer_scene_config	SceneConfig	可选			部门限制可见的生效场景配置
└ active Boolean 可选 true 当前部门是否采用单独的配置。如果设置了false，则采用组织维度的配置 └ profile Boolean 可选 true 是否在个人资料页生效 └ search Boolean 可选 true 是否在搜索生效 └ chatbox_subtitle Boolean 可选 true 是否在单聊框生效 └ node_list Boolean 可选 true 是否在查看组织架构生效
emp_apply_join_dept	Boolean	可选	true		开启后，允许员工加入部门
code	String	可选	10000		部门编码

响应参数

名称	类型	示例值	描述
errcode	Number	0	返回码
errmsg	String	ok	错误信息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/department/update");
OapiV2DepartmentUpdateRequest req = new OapiV2DepartmentUpdateRequest();
req.setDeptId(100L);
req.setParentId(2L);
req.setOuterDept(true);
req.setHideDept(true);
req.setCreateDeptGroup(true);
req.setOrder(10L);
req.setName("HR");
req.setSourceIdentifier("HR部门");
req.setDeptPermits("3,4,5");
req.setUserPermits("100,200");
req.setOuterPermitUsers("500,600");
req.setOuterPermitDepts("6,7,8");
req.setOuterDeptOnlySelf(true);
req.setExtensionString("{\"姓名\":\"张三\"}");
req.setLanguage("zh_CN");
req.setAutoAddUser(false);
req.setDeptManagerUseridList("200,300");
req.setGroupContainSubDept(true);
req.setGroupContainOuterDept(true);
req.setGroupContainHiddenDept(true);
req.setOrgDeptOwner("100");
req.setBrief("这是简介");
req.setTelephone("138xxxx0000");
req.setAutoApproveApply(true);
req.setForceUpdateFields("dept_manager_userid_list");
SceneConfig obj1 = new SceneConfig();
obj1.setActive(true);
obj1.setProfile(true);
obj1.setSearch(true);
obj1.setNodeList(true);
obj1.setChatboxSubtitle(true);
req.setHideSceneConfig(obj1);
SceneConfig obj2 = new SceneConfig();
obj2.setActive(true);
obj2.setProfile(true);
obj2.setSearch(true);
obj2.setChatboxSubtitle(true);
obj2.setNodeList(true);
req.setOuterSceneConfig(obj2);
req.setEmpApplyJoinDept(true);
req.setCode("10000");
OapiV2DepartmentUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/department/update");
OapiV2DepartmentUpdateRequest req = new OapiV2DepartmentUpdateRequest();
req.DeptId = 100L;
req.ParentId = 2L;
req.OuterDept = true;
req.HideDept = true;
req.CreateDeptGroup = true;
req.Order = 10L;
req.Name = "HR";
req.SourceIdentifier = "HR部门";
req.DeptPermits = "3,4,5";
req.UserPermits = "100,200";
req.OuterPermitUsers = "500,600";
req.OuterPermitDepts = "6,7,8";
req.OuterDeptOnlySelf = true;
req.Extension = "{\"姓名\":\"张三\"}";
req.Language = "zh_CN";
req.AutoAddUser = false;
req.DeptManagerUseridList = "200,300";
req.GroupContainSubDept = true;
req.GroupContainOuterDept = true;
req.GroupContainHiddenDept = true;
req.OrgDeptOwner = "100";
req.Brief = "这是简介";
req.Telephone = "138xxxx0000";
req.AutoApproveApply = true;
req.ForceUpdateFields = "dept_manager_userid_list";
OapiV2DepartmentUpdateRequest.SceneConfigDomain obj1 = new OapiV2DepartmentUpdateRequest.SceneConfigDomain();
obj1.Active = true;
obj1.Profile = true;
obj1.Search = true;
obj1.NodeList = true;
obj1.ChatboxSubtitle = true;
req.HideSceneConfig_ = obj1;
OapiV2DepartmentUpdateRequest.SceneConfigDomain obj2 = new OapiV2DepartmentUpdateRequest.SceneConfigDomain();
obj2.Active = true;
obj2.Profile = true;
obj2.Search = true;
obj2.ChatboxSubtitle = true;
obj2.NodeList = true;
req.OuterSceneConfig_ = obj2;
req.EmpApplyJoinDept = true;
req.Code = "10000";
OapiV2DepartmentUpdateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2DepartmentUpdateRequest;
$req->setDeptId("100");
$req->setParentId("2");
$req->setOuterDept("true");
$req->setHideDept("true");
$req->setCreateDeptGroup("true");
$req->setOrder("10");
$req->setName("HR");
$req->setSourceIdentifier("HR部门");
$req->setDeptPermits("3,4,5");
$req->setUserPermits("100,200");
$req->setOuterPermitUsers("500,600");
$req->setOuterPermitDepts("6,7,8");
$req->setOuterDeptOnlySelf("true");
$req->setExtension("{\"姓名\":\"张三\"}");
$req->setLanguage("zh_CN");
$req->setAutoAddUser("false");
$req->setDeptManagerUseridList("200,300");
$req->setGroupContainSubDept("true");
$req->setGroupContainOuterDept("true");
$req->setGroupContainHiddenDept("true");
$req->setOrgDeptOwner("100");
$req->setBrief("这是简介");
$req->setTelephone("138xxxx0000");
$req->setAutoApproveApply("true");
$req->setForceUpdateFields("dept_manager_userid_list");
$hide_scene_config = new SceneConfig;
$hide_scene_config->active="true";
$hide_scene_config->profile="true";
$hide_scene_config->search="true";
$hide_scene_config->node_list="true";
$hide_scene_config->chatbox_subtitle="true";
$req->setHideSceneConfig($hide_scene_config);
$outer_scene_config = new SceneConfig;
$outer_scene_config->active="true";
$outer_scene_config->profile="true";
$outer_scene_config->search="true";
$outer_scene_config->chatbox_subtitle="true";
$outer_scene_config->node_list="true";
$req->setOuterSceneConfig($outer_scene_config);
$req->setEmpApplyJoinDept("true");
$req->setCode("10000");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/v2/department/update");

curl -X POST "https://oapi.dingtalk.com/topapi/v2/department/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0ea3299e-ae47-42ac-af56-b5112051581f' \
-d 'auto_add_user=false' \
-d 'auto_approve_apply=true' \
-d 'brief=%E8%BF%99%E6%98%AF%E7%AE%80%E4%BB%8B' \
-d 'code=10000' \
-d 'create_dept_group=true' \
-d 'dept_id=100' \
-d 'dept_manager_userid_list=200%2C300' \
-d 'dept_permits=3%2C4%2C5' \
-d 'emp_apply_join_dept=true' \
-d 'extension=%7B%5C%22%E5%A7%93%E5%90%8D%5C%22%3A%5C%22%E5%BC%A0%E4%B8%89%5C%22%7D' \
-d 'force_update_fields=dept_manager_userid_list' \
-d 'group_contain_hidden_dept=true' \
-d 'group_contain_outer_dept=true' \
-d 'group_contain_sub_dept=true' \
-d 'hide_dept=true' \
-d 'hide_scene_config=null' \
-d 'language=zh_CN' \
-d 'name=HR' \
-d 'order=10' \
-d 'org_dept_owner=100' \
-d 'outer_dept=true' \
-d 'outer_dept_only_self=true' \
-d 'outer_permit_depts=6%2C7%2C8' \
-d 'outer_permit_users=500%2C600' \
-d 'outer_scene_config=null' \
-d 'parent_id=2' \
-d 'source_identifier=HR%E9%83%A8%E9%97%A8' \
-d 'telephone=138xxxx0000' \
-d 'user_permits=100%2C200'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiV2DepartmentUpdateRequest("https://oapi.dingtalk.com/topapi/v2/department/update")

req.dept_id=100
req.parent_id=2
req.outer_dept=true
req.hide_dept=true
req.create_dept_group=true
req.order=10
req.name="HR"
req.source_identifier="HR部门"
req.dept_permits="3,4,5"
req.user_permits="100,200"
req.outer_permit_users="500,600"
req.outer_permit_depts="6,7,8"
req.outer_dept_only_self=true
req.extension="{\"姓名\":\"张三\"}"
req.language="zh_CN"
req.auto_add_user=false
req.dept_manager_userid_list="200,300"
req.group_contain_sub_dept=true
req.group_contain_outer_dept=true
req.group_contain_hidden_dept=true
req.org_dept_owner="100"
req.brief="这是简介"
req.telephone="138xxxx0000"
req.auto_approve_apply=true
req.force_update_fields="dept_manager_userid_list"
req.hide_scene_config=""
req.outer_scene_config=""
req.emp_apply_join_dept=true
req.code="10000"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.v2.department.update");
add_param(pRequest,"dept_id","100");
add_param(pRequest,"parent_id","2");
add_param(pRequest,"outer_dept","true");
add_param(pRequest,"hide_dept","true");
add_param(pRequest,"create_dept_group","true");
add_param(pRequest,"order","10");
add_param(pRequest,"name","HR");
add_param(pRequest,"source_identifier","HR部门");
add_param(pRequest,"dept_permits","3,4,5");
add_param(pRequest,"user_permits","100,200");
add_param(pRequest,"outer_permit_users","500,600");
add_param(pRequest,"outer_permit_depts","6,7,8");
add_param(pRequest,"outer_dept_only_self","true");
add_param(pRequest,"extension","{\"姓名\":\"张三\"}");
add_param(pRequest,"language","zh_CN");
add_param(pRequest,"auto_add_user","false");
add_param(pRequest,"dept_manager_userid_list","200,300");
add_param(pRequest,"group_contain_sub_dept","true");
add_param(pRequest,"group_contain_outer_dept","true");
add_param(pRequest,"group_contain_hidden_dept","true");
add_param(pRequest,"org_dept_owner","100");
add_param(pRequest,"brief","这是简介");
add_param(pRequest,"telephone","138xxxx0000");
add_param(pRequest,"auto_approve_apply","true");
add_param(pRequest,"force_update_fields","dept_manager_userid_list");
add_param(pRequest,"hide_scene_config","数据结构JSON示例");
add_param(pRequest,"outer_scene_config","数据结构JSON示例");
add_param(pRequest,"emp_apply_join_dept","true");
add_param(pRequest,"code","10000");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.v2.department.update', {
	'dept_id':'100',
	'parent_id':'2',
	'outer_dept':'true',
	'hide_dept':'true',
	'create_dept_group':'true',
	'order':'10',
	'name':'HR',
	'source_identifier':'HR部门',
	'dept_permits':'3,4,5',
	'user_permits':'100,200',
	'outer_permit_users':'500,600',
	'outer_permit_depts':'6,7,8',
	'outer_dept_only_self':'true',
	'extension':'{\"姓名\":\"张三\"}',
	'language':'zh_CN',
	'auto_add_user':'false',
	'dept_manager_userid_list':'200,300',
	'group_contain_sub_dept':'true',
	'group_contain_outer_dept':'true',
	'group_contain_hidden_dept':'true',
	'org_dept_owner':'100',
	'brief':'这是简介',
	'telephone':'138xxxx0000',
	'auto_approve_apply':'true',
	'force_update_fields':'dept_manager_userid_list',
	'hide_scene_config':'数据结构JSON示例',
	'outer_scene_config':'数据结构JSON示例',
	'emp_apply_join_dept':'true',
	'code':'10000'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

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

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.v2.department.update (更新部门)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ