更新部门ID

调用该接口可以更新部门的自定义 ID，即 department_id。

注意事项

本接口仅支持使用应用身份（tenant_access_token）调用。调用时，应用的通讯录权限范围内需要包含当前被操作的部门。了解权限范围参见权限范围资源介绍。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/departments/:department_id/update_department_id
HTTP Method	PATCH
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:contact:update_department_id 更新部门 ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
department_id	string	需要更新自定义 ID 的部门 ID，该 ID 类型需要与查询参数 department_id_type 的取值一致。ID 获取方式说明： - 调用创建部门接口后，可从返回结果中获取到部门 ID 信息。 - 部门 API 提供了多种获取其他部门 ID 的方式，如获取子部门列表、获取父部门信息、搜索部门，你可以选择合适的 API 进行查询。 示例值："od-d6b83d25c129775723a36f52495c4f81" 数据校验规则： - 最大长度：64 字符 - 正则校验：^[a-zA-Z0-9][a-zA-Z0-9_\-@.]{0,63}$

查询参数

名称	类型	必填	描述
department_id_type	string	否	此次调用中的部门 ID 类型。关于部门 ID 的详细介绍，可参见部门 ID 说明。 默认值：open_department_id 示例值：open_department_id 可选值有： - department_id: 支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id，因此在未删除的部门范围内 department_id 具有唯一性。 - open_department_id: 由系统自动生成的部门 ID，ID 前缀固定为 od-，在租户内全局唯一。

请求体

名称	类型	必填	描述
new_department_id	string	是	新的自定义部门 ID，即部门的 department_id。 注意： - 不能以 od- 开头。 - 不能设置为 0。 - 不能与其他未删除部门的 department_id 重复。 示例值："NewDevDepartID" 数据校验规则： - 最大长度：128 字符 - 正则校验：`^0

请求体示例

{
    "new_department_id": "NewDevDepartID"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	40001	invalid params	参数错误，请对照接口文档修改输入参数后重试。
400	43009	exceed update custom dept limit error	超过最大更新限制。
403	40007	can not update dept custom id error	无法更新部门自定义 ID。你需要在应用的通讯录权限范围内添加当前操作的部门。了解应用的通讯录权限范围，可参见权限范围资源介绍。
401	42008	tenant id is invalid error	租户身份无效。请求时，请确保设置的请求头 Authorization 与待操作资源同属一个租户下。

更多错误码信息，参见通用错误码。