创建部门

POST

/open-apis/contact/v3/departments

自建应用商店应用

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

错误码

HTTP状态码	错误码	描述	排查建议
400	43005	duplicate order error	部门的order必须唯一，请检查后重试。
400	40018	param error	参数错误
400	43008	custom dept id invalid error	部门自定义ID不合法，不得以od-开头，不能为“0”，长度不可超过64。
400	43013	dept too many children error	子部门数量过多。
400	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
403	40004	no dept authority error	操作的部门需在通讯录权限范围中，了解更多
400	40008	dept Info is null error	部门的信息不能为空
400	40010	chat id is invalid error	部门群ID格式错误。
403	40014	no parent dept authority error	没有父部门权限（组织架构可见范围权限）。
401	43000	dept has already exist error	创建的部门已经存在。
401	40016	dept name can not be nul error	部门名不能为空。
400	42006	user has resigned error	用户已经离职。
400	41012	user id invalid error	用户ID无效。
400	40021	no a same request error	两次操作不是同一个请求，请检查request值是否有改动。
400	43004	illegal unit error	部门unit id无效。
400	43007	duplicated department custom id error	部门自定义ID 企业内重复
403	40004	no dept authority error	操作的部门需在通讯录权限范围中，了解更多
400	44101	miss parent department id error	请求缺少 parent department id
400	43017	relate dept over limit	关联部门超过限制
400	43018	duplicate i18n name	重复的i18n名字
400	43019	exceed dept max level	超过部门层级深度
400	43021	department chat not exist	部门群不存在
400	43022	department name duplicate	部门名重复
400	43023	dept structure no permissione	组织架构没有权限
400	43024	dept structure tenant lock fail	部门结构变动获取租户锁失败
400	43025	top department leader unjoined	用户未加入不能成为企业负责人
400	43026	employee type is not valid	请使用准确的雇员类型

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/contact/v3/departments' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "DemoName",
    "i18n_name": {
        "zh_cn": "Demo名称",
        "ja_jp": "デモ名",
        "en_us": "Demo Name"
    },
    "parent_department_id": "D067",
    "department_id": "D096",
    "leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
    "order": "100",
    "unit_ids": [
        "custom_unit_id"
    ],
    "create_group_chat": false
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "department": {
      "name": "DemoName",
      "i18n_name": {
        "zh_cn": "Demo名称",
        "ja_jp": "デモ名",
        "en_us": "Demo Name"
      },
      "parent_department_id": "D067",
      "department_id": "D096",
      "open_department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
      "leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
      "chat_id": "oc_5ad11d72b830411d72b836c20",
      "order": "100",
      "unit_ids": [
        "custom_unit_id"
      ],
      "member_count": 100,
      "status": {
        "is_deleted": false
      }
    }
  }
}

请求参数

Query 参数

user_id_type

可选

用户 ID 类型示例值："open_id" 可选值有： open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

department_id_type

可选

此次调用中使用的部门ID的类型不同 ID 的说明参见部门ID说明示例值："open_department_id" 可选值有： department_id：用来标识租户内一个唯一的部门 open_department_id：用来在具体某个应用中标识一个部门，同一个部门在不同应用中的 open_department_id 不相同。

示例值:

open_department_id

client_token

可选

用于幂等判断是否为同一请求，避免重复创建。字符串类型，自行生成。示例值："473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"

示例值:

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

name

string

必需

部门名称示例值："DemoName" 数据校验规则：最小长度：1 字符

i18n_name

object

国际化的部门名称

可选

zh_cn

string

可选

部门的中文名示例值："Demo名称"

ja_jp

string

可选

部门的日文名示例值："デモ名"

en_us

string

可选

部门的英文名示例值："Demo Name"

parent_department_id

string

必需

父部门的ID 创建根部门，该参数值为 “0” 示例值："D067"

department_id

string

可选

本部门的自定义部门ID 示例值："D096" 数据校验规则：最大长度：64 字符正则校验：^0|[^od][A-Za-z0-9]*

leader_user_id

string

可选

部门主管用户ID 示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"

order

string

可选

部门的排序，即部门在其同级部门的展示顺序示例值："100"

unit_ids

array[string]

可选

部门单位自定义ID列表，当前只支持一个示例值：custom_unit_id

create_group_chat

boolean

可选

是否创建部门群，默认不创建示例值：false

leaders

array [object {2}]

部门负责人

可选

leaderID

string

可选

负责人类型示例值：1 可选值有： 1：主负责人 2：副负责人

leaderType

integer

必需

负责人ID 示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"

group_chat_employee_types

boolean

可选

部门群雇员类型限制。[]空列表时，表示为无任何雇员类型。类型字段可包含以下值，支持多个类型值；若有多个，用英文','分隔：1、正式员工2、实习生3、外包4、劳务5、顾问6、其他自定义类型字段，可通过下方接口获取到该租户的自定义员工类型的名称，参见获取人员类型。示例值：[1,2,3]

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

department

object

部门信息

必需

修改于 2023-01-12 05:46:39

修改部门信息

删除部门

创建部门

错误码#

请求参数

返回响应

错误码