跳到主要内容

更新企业部门信息

1. 接口描述

接口请求域名: ess.tencentcloudapi.com 。

此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:ModifyIntegrationDepartment。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。
DeptIdString电子签部门ID,通过DescribeIntegrationDepartments接口获得。
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
ParentDeptIdString电子签父部门ID,通过DescribeIntegrationDepartments接口获得。
DeptNameString部门名称,最大长度为50个字符。
DeptOpenIdString客户系统部门ID,最大长度为64个字符。
OrderNoInteger排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。

3. 输出参数

参数名称类型描述
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新企业部门信息

更新部门ID对应部门的部门名称、客户系统部门ID和排序号。

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIntegrationDepartment
<公共请求参数>

{
"Operator": {
"UserId": "yDwgKUUcXXXXXXXXXXXXQZDRuD"
},
"DeptName": "运营部",
"DeptId": "yDwgIUUckp1gXXXXXXXXE8xOm12b9",
"DeptOpenId": "open_dept1",
"OrderNo": 1
}

输出示例

{
"Response": {
"RequestId": "072125ef-xxxx-xxxx-xxxx-xxxxxx45dab9"
}
}

示例2 错误示例-参数不合法

在使用此接口时,需要按照入参描述进行相应的设置,以确保参数的合法性。如果参数设置不合法,此接口将返回错误信息。

  1. 客户系统部门ID超过限制长度(64字符)

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIntegrationDepartment
<公共请求参数>

{
"Operator": {
"UserId": "yDwgKUUcXXXXXXXXXXXXQZDRuD"
},
"DeptName": "运营部",
"DeptId": "yDwgIUUckp1gXXXXXXXXE8xOm12b9",
"DeptOpenId": "abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz-abcdefghijklmnopqrstuvwxyz",
"OrderNo": 1
}

输出示例

{
"Response": {
"Error": {
"Code": "InvalidParameter.ParamError",
"Message": "部门openId请控制在64个字符以内"
},
"RequestId": "072125ef-xxxx-xxxx-xxxx-xxxxxx45dab9"
}
}

示例3 错误示例-数据不存在

在使用此接口时,请确认入参部门ID正确无误。如果参数设置不正确,此接口将返回错误信息。

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyIntegrationDepartment
<公共请求参数>

{
"Operator": {
"UserId": "yDwgKUUcXXXXXXXXXXXXQZDRuD"
},
"DeptName": "运营部",
"DeptId": "yDwgIUUckp1gXXXXXXXXE8xOm12b9",
"DeptOpenId": "1234",
"OrderNo": 1
}

输出示例

{
"Response": {
"Error": {
"Code": "InvalidParameter.DataNotFound",
"Message": "父部门不存在,请核对后重试"
},
"RequestId": "072125ef-xxxx-xxxx-xxxx-xxxxxx45dab9"
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
FailedOperation操作失败。
InvalidParameter.DataExists数据已存在。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062