Skip to content

更新人员类型

调用该接口更新指定的自定义人员类型信息。

注意事项

仅支持更新自定义的人员类型。默认包含的正式、实习、外包、劳务、顾问五个选项不支持更新。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/contact/v3/employee_type_enums/:enum_id
HTTP MethodPUT
接口频率限制特殊频控
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用contact:contact 更新通讯录

请求头

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

路径参数

名称类型描述
enum_idstring自定义人员类型的选项 ID。你可以在新建人员类型时从返回值中获取,你也可以调用查询人员类型接口,获取选项的 ID。
示例值:"exGeIjow7zIqWMy+ONkFxA=="

请求体

名称类型必填描述
contentstring选项内容。
示例值:"专家"
数据校验规则
- 长度范围:1100 字符
enum_typeint选项类型。更新人员类型时固定取值为 2 即可。
示例值:2
可选值有
- 1: 内置类型。该类型仅用于查询结果当中,更新人员类型时不支持选择该类型。 - 2: 自定义。
enum_statusint选项的激活状态。只有已激活的选项可以用于配置用户属性。
示例值:1
可选值有
- 1: 激活 - 2: 未激活
i18n_contenti18n_content\[\]选项内容的国际化配置。
说明
- 在飞书客户端查看用户人员类型时,系统会根据客户端语言环境,自动展示相匹配的选项语言。如果相应语言不在选项国际化配置当中,则会展示默认选项内容(即 content 字段)。 - 不传值表示不更新原有配置。
  └ localestring语言版本。例如:
- zh_cn:中文 - en_us:英文 - ja_jp:日文
示例值:"zh_cn"
  └ valuestring语言版本对应的内容。
数据校验规则:
长度范围:1 字符 ~ 100 字符
示例值:"专家(中文)"

请求体示例

json
{
    "content": "专家",
    "enum_type": 2,
    "enum_status": 1,
    "i18n_content": [
        {
            "locale": "zh_cn",
            "value": "专家(中文)"
        }
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ employee_type_enumemployee_type_enum更新后的人员类型字段信息。
    └ enum_idstring人员类型的选项 ID。后续可以使用该 ID 更新、删除选项。
    └ enum_valuestring选项的编号值,由系统生成的编号。后续可使用该编号配置用户的人员类型属性。例如,调用创建用户接口时,employee_type 参数值对应的就是当前的 enum_value。
    └ contentstring选项内容。
    └ enum_typeint选项类型。
可选值有
- 1: 内置类型 - 2: 自定义
    └ enum_statusint选项的激活状态。
可选值有
- 1: 激活 - 2: 未激活
    └ i18n_contenti18n_content\[\]选项内容的国际化配置。
      └ localestring语言版本。例如:
- zh_cn:中文 - en_us:英文 - ja_jp:日文
      └ valuestring语言版本对应的内容。

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "employee_type_enum": {
            "enum_id": "exGeIjow7zIqWMy+ONkFxA==",
            "enum_value": "2",
            "content": "专家",
            "enum_type": 2,
            "enum_status": 1,
            "i18n_content": [
                {
                    "locale": "zh_cn",
                    "value": "专家(中文)"
                }
            ]
        }
    }
}

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理