# 修改部门所有信息

该接口用于更新当前部门所有信息。

只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门,则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/contact/departments/:department_id
HTTP Method PUT
支持的应用类型 仅自建应用
权限要求 更新通讯录
字段权限要求 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请
获取部门组织架构信息
以应用身份读取通讯录
获取部门基础信息
获取用户 user ID

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)

名称 类型 描述
department_id string 部门ID

# 查询参数

名称 类型 必填 描述
user_id_type string 用户 ID 类型
示例值:"open_id"
可选值有
* open_id:标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
* union_id:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。
* user_id:标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。
默认值open_id
当值为 user_id,字段权限要求
获取用户 user ID

# 请求体

名称 类型 必填 描述
name string 部门名称
字段权限要求(满足任一)
获取部门基础信息
parent_department_id string 父部门的ID
字段权限要求(满足任一)
获取部门组织架构信息
leader_user_id string 部门主管用户ID
字段权限要求(满足任一)
获取用户 user_id
order string 部门的排序,即部门在其同级部门的展示顺序

# 请求体示例

{
  "name": "开放平台测试",
  "parent_department_id": "0101",
  "leader_user_id": "1001",
  "order": "1"
}
1
2
3
4
5
6

# 响应

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
 ∟name string 部门名称
字段权限要求(满足任一)
获取部门基础信息
 ∟parent_department_id string 父部门的ID
字段权限要求(满足任一)
获取部门组织架构信息
 ∟department_id string 本部门的自定义部门ID
字段权限要求(满足任一)
获取部门基础信息
 ∟leader_user_id string 部门主管用户ID
字段权限要求(满足任一)
获取用户 user_id
 ∟order int 部门的排序,即部门在其同级部门的展示顺序
 ∟member_count int 部门下用户的个数
 ∟status object 部门状态
字段权限要求(满足任一)
获取部门基础信息
  ∟ is_deleted boolean 是否已删除

# 响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "data": [
    {
      "department_id": "0104",
      "name": "公共资源",
      "parent_department_id": "01",
      "leader_user_id": "13637",
      "order": 0,
      "member_count": 4,
      "status": {
        "is_deleted": false
      }
    }
  ],
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
最后更新于 : 8/16/2024, 10:52:48 AM