更新自定义组织基础信息

更新一个自定义组织基础信息，不支持更新自动匹配规则，如需更新自动匹配规则请使用更新匹配规则

Tip: - 非必填字段，不传时即不做变更。

• 如果传入生效时间当天不存在版本则会自动生成一个版本。
• 如果传入生效时间当天存在版本则会修改该版本。

Error: 如果是新建版本时，会将停用版本更新为启用版本

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/custom_orgs/:org_id
HTTP Method	PATCH
接口频率限制	5 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:custom_org:write 读写自定义组织信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
org_id	string	自定义组织 ID - 可从 批量查询自定义组织的 org_id 字段中获取。 示例值："6862995757234914824"

查询参数

名称	类型	必填	描述
client_token	string	否	根据 client_token 是否一致来判断是否为同一请求 示例值：1245464678 数据校验规则： - 长度范围：0 ～ 128 字符
user_id_type	string	否	用户 ID 类型 示例值：people_corehr_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？ - people_corehr_id: 以飞书人事的 ID 来识别用户 默认值：people_corehr_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
object_api_name	string	是	组织类型编码，可在「飞书人事-设置-组织设置」中相应的自定义组织目录下查看 示例值："custom_org_01" 数据校验规则： - 长度范围：1 ～ 128 字符
names	i18n\[\]	否	组织名称 - 相同上级的自定义组织中英文名称不允许重复。 - 名称不能包含「/」「；」「;」「\」「'」字符。 数据校验规则： - 长度范围：0 ～ 5
└ lang	string	是	语言信息，中文用zh-CN，英文用en-US 示例值："zh-CN"
└ value	string	是	具体内容 示例值："中文示例"
code	string	否	自定义组织编码 (不能与其他记录的编码重复) - 开启自动编码时，如果不传值会自动生成编码，否则以传入值为准 - 未开启自动编码时，不传值不会自动生成编码 示例值："MDPD00000023"
parent_id	string	否	上级组织 ID - 可从 批量查询自定义组织的 org_id 字段中获取。 示例值："6862995757234914824"
manager_ids	string\[\]	否	负责人 ID 列表。 - 详细信息可通过【搜索员工信息】 或 【批量查询员工】 接口获取，ID 为返回值中的 ==employment_id== 示例值：["6862995757234914824"] 数据校验规则： - 长度范围：0 ～ 100
description	i18n\[\]	否	自定义组织描述 数据校验规则： - 长度范围：0 ～ 5
└ lang	string	是	语言, 中文用 zh-CN ，英文用 en-US 示例值："zh-CN"
└ value	string	是	文本内容 示例值："中文示例"
effective_time	string	是	自定义组织生效时间 - 填写格式： YYYY-MM-DD - 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日 - 日期范围要求:1900-01-01 ～ 9999-12-31 示例值："2020-01-01" 数据校验规则： - 长度范围：10 ～ 10 字符 - 正则校验：`^((([0-9]{3}[1-9]
org_roles	org_role_update\[\]	否	自动给「按自定义组织授权的角色」授权 数据校验规则： - 长度范围：0 ～ 64
└ api_name	string	否	角色key - api_name、security_group_id必须填一个 - 可以通过页面「飞书人事-设置-组织配置」选择对应自定义组织，「字段配置-字段编码」获取 示例值："hcm_corehr_xxxxxx"
└ security_group_id	string	否	角色ID - api_name、security_group_id必须填一个 - 可以通过批量获取角色列表 获取，数据为返回数据中的 data.items.id 值。筛选条件data.items.group_type == 3（组织角色），data.items.org_truncation 关联的组织有且仅有一个，data.items.org_truncation.org_key 等于当前查询自定义组织 object_api_name 示例值："7034393015968122400"
└ employment_ids	string\[\]	否	被授权的员工 ID 列表 - 详细信息可通过【搜索员工信息】 或 【批量查询员工】 接口获取 示例值：["6862995757234914824"] 数据校验规则： - 长度范围：0 ～ 100
custom_fields	custom_field_data\[\]	否	自定义字段类型，详细见获取自定义字段列表 数据校验规则： - 长度范围：0 ～ 200
└ custom_api_name	string	是	自定义字段 API Name，即自定义字段的唯一标识 示例值："name"
└ value	string	是	字段值，为 JSON 转义后的字符串。 注意：具体传值方式参见获取自定义字段的元数据 示例值：""231""

请求体示例

{
    "object_api_name": "custom_org_01",
    "names": [
        {
            "lang": "zh-CN",
            "value": "中文示例"
        }
    ],
    "code": "MDPD00000023",
    "parent_id": "6862995757234914824",
    "manager_ids": [
        "6862995757234914824"
    ],
    "description": [
        {
            "lang": "zh-CN",
            "value": "中文示例"
        }
    ],
    "effective_time": "2020-01-01",
    "org_roles": [
        {
            "api_name": "hcm_corehr_xxxxxx",
            "security_group_id": "7034393015968122400",
            "employment_ids": [
                "6862995757234914824"
            ]
        }
    ],
    "custom_fields": [
        {
            "custom_api_name": "name",
            "value": "\"231\""
        }
    ]
}

响应

响应体

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

响应体示例

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

错误码

HTTP状态码	错误码	描述	排查建议
400	1160263	The code already exists	编码不能为空
400	1160255	Parent organization hasn't taken effect on effective date	检查上级组织是否生效
400	1160256	Parent organization will be deactivated on or after this effective date	检查上级组织是否失效
400	1160264	This operation will make the relationship between the superior and the subordinate into a ring	检查上下级关系是否成环
400	1161603	Name already exists	检查名称是否与相同上级组织下的其他同级组织重名
400	1160271	Unable to submit as no changes have been made	内容没有变化，更新失败
503	1161204	Requset timeout	联系飞书人事 Oncall
429	1161604	QPS over limit	联系飞书人事 Oncall