更新背调自定义字段

更新用户在发起背调时展示的表单自定义字段名称和描述。

Warning: * 更新操作将影响已发起的背调表单展示，但不影响实际背调内容。

• 更新操作只允许更新已有字段的名称和描述，不支持更新字段类型，也不允许新增或删除自定义字段。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/hire/v1/eco_background_check_custom_fields/batch_update
HTTP Method	PATCH
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	hire:background_check_order 更新招聘背调信息

请求头

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

请求体

名称	类型	必填	描述
account_id	string	是	背调账号 ID，可通过账号绑定事件获取 示例值："6995842370159937061"
custom_field_list	eco_background_check_custom_field_data\[\]	是	自定义字段列表。 注意：列表长度须与创建背调自定义字段时传入的一致
└ type	string	是	自定义字段类型 示例值："select" 可选值有： - text: 单行文本，最多100个汉字 - textarea: 多行文本，最多200个汉字 - number: 数字 - boolean: 布尔 - select: 单选 - multiselect: 多选 - date: 日期 - file: 附件 - resume: 候选人简历
└ key	string	是	自定义字段的标识，在同一账号内唯一 示例值："candidate_degree"
└ name	i18n	是	自定义字段的名称，用户在安排背调表单看到的控件标题
└ zh_cn	string	否	中文名称 示例值："候选人学历"
└ en_us	string	否	英文名称 示例值："Candidate's degree"
└ is_required	boolean	是	是否必填 示例值：true
└ description	i18n	否	自定义字段的描述，如果是输入控件，为用户在安排背调表单看到的 placeholder 或 提示文字
└ zh_cn	string	否	中文描述 示例值："候选人真实学历"
└ en_us	string	否	英文描述 示例值："The candidate's real degree"
└ options	eco_background_check_custom_field_data_option\[\]	否	type 为 select 或 multiselect 时必填，单选或多选的选项
└ key	string	是	选项的唯一标识 示例值："bachelor"
└ name	i18n	是	选项的名称
└ zh_cn	string	否	中文名称 示例值："本科"
└ en_us	string	否	英文名称 示例值："Bachelor"

请求体示例

{
    "account_id": "6995842370159937061",
    "custom_field_list": [
        {
            "type": "select",
            "key": "candidate_degree",
            "name": {
                "zh_cn": "候选人学历",
                "en_us": "Candidate's degree"
            },
            "is_required": true,
            "description": {
                "zh_cn": "候选人真实学历",
                "en_us": "The candidate's real degree"
            },
            "options": [
                {
                    "key": "bachelor",
                    "name": {
                        "zh_cn": "本科",
                        "en_us": "Bachelor"
                    }
                }
            ]
        }
    ]
}

响应

响应体

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

响应体示例

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

错误码

HTTP状态码	错误码	描述	排查建议
400	1002001	参数错误或系统异常	请根据实际报错信息定位问题或联系技术支持