Header 参数	是否必填	描述
`Authorization`	是	固定取值为 `Bearer {access_token}`。关于如何获取访问令牌，参考鉴权。
`Content-Type`	是	固定取值为 `application/json`。

路径参数

参数类型 是否必填 默认值 描述

参数	类型	是否必填	默认值	描述
`id`	string	是	-	待更新部门的 ID。部门 ID 可以通过 “获取单个父部门的子部门” 接口或 ”按关键词搜索部门“ 接口获取。

id

string

是

待更新部门的 ID。

部门 ID 可以通过 “获取单个父部门的子部门” 接口或 ”按关键词搜索部门“ 接口获取。

请求体参数

参数类型 是否必填 默认值 描述

参数	类型	是否必填	默认值	描述
`name`	string	条件必填	-	该部门的新名称。与 `parent_department_id` 至少传一个。去除首尾空白后不能为空，最多 30 个 Unicode 字符。
`parent_department_id`	string	条件必填	-	该部门所属的新父部门的 ID。与 `name` 至少传一个。`"0"` 或 `""` 表示将该部门移动到企业根部门下。不能把部门移动到自身或其子部门之下。如何获取部门 ID：在 TRAE 企业版控制台中，前往企业管理 > 人员管理 > 部门管理，然后点击操作栏中的详情获取目标部门的 ID。

name

string

条件必填

该部门的新名称。

与 parent_department_id 至少传一个。去除首尾空白后不能为空，最多 30 个 Unicode 字符。

parent_department_id

string

条件必填

该部门所属的新父部门的 ID。

与 name 至少传一个。"0" 或 "" 表示将该部门移动到企业根部门下。不能把部门移动到自身或其子部门之下。

如何获取部门 ID：在 TRAE 企业版控制台中，前往 企业管理 > 人员管理 > 部门管理，然后点击操作栏中的详情获取目标部门的 ID。

响应参数

该接口独有的响应参数如下，参数位于 data 中。通用响应参数参考此文档。

参数	类型	描述
`success`	bool	是否更新成功。成功时为 `true`，失败时为 `false`。

示例

请求示例

curl -X PATCH "${HOST}/openapi/v1/departments/10001" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "研发2部",
    "parent_department_id": "10002",
  }'

响应示例

{
  "code": 0,
  "message": "success",
  "request_id": "req_xxx",
  "data": {
    "success": true
  }
}

错误码

若该接口的请求返回错误码，参考错误码文档进行排查。

文档对您有帮助吗?