删除账号自定义字段
飞书招聘的背调或笔试服务商,可通过此接口删除账号自定义字段(如客户在服务商处的租户 ID、账号 ID等)。
Warning: * 删除操作不支持撤销,对应的自定义字段的 key 将无法重复使用。
- 该接口不支持删除所有的自定义字段——即须保留至少一个自定义字段。如需删除所有字段,可先通过创建账号自定义字段接口新增,然后将多余的自定义字段删除。
- 删除后,客户已有账号的自定义字段的值不受影响,只影响添加新账号时的表单展示。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/eco_account_custom_fields/batch_delete |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | hire:background_check_order 更新招聘背调信息 hire:exam 更新笔试信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
scope | int | 是 | 适用范围 示例值:1 可选值有: - 1: 背调 - 2: 笔试 |
custom_field_key_list | string\[\] | 否 | 要删除的自定义字段的 key 列表 示例值:["account_token_v1"] |
请求体示例
json
{
"scope": 1,
"custom_field_key_list": [
"account_token_v1"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "ok",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
