# 创建账号自定义字段

飞书招聘的背调或笔试服务商，可通过此接口创建账号自定义字段，用来标识飞书招聘客户在服务商处的身份（比如客户在服务商处的租户 ID、账号 ID等字段）。

**注意事项**：* 对于飞书招聘客户的自建应用，客户须先在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」添加自建应用后，才可调用本接口。
* 本接口为全量更新，多次调用时，将生效最后一次调用传入的自定义字段。

## 使用流程
客户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」添加服务商账号时，需填写本接口创建的自定义字段，之后系统将通过[账号绑定](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account/events/created)事件将客户填入的自定义字段值推送给服务商，服务商可据此识别和绑定飞书招聘客户，并以此来[创建背调套餐和附加调查项](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check_package/create)或[创建试卷列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam_paper/create)等。
<br>详细的接入步骤可参考 [背调/笔试生态接入概览文档](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/ecological-docking/summary)。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/eco_account_custom_fields
HTTP Method | POST
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 更新招聘背调信息(hire:background_check_order)<br>更新笔试信息(hire:exam)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
scope | int | 是 | 适用范围<br>**示例值**：1<br>**可选值有**：<br>- 1：背调<br>- 2：笔试
custom_field_list | eco_account_custom_field_data\[\] | 是 | 自定义字段列表
key | string | 是 | 自定义字段的标识。在同一`scope`内须唯一<br>**示例值**："account_token"
name | i18n | 是 | 自定义字段的名称。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的表单控件标题
zh_cn | string | 否 | 自定义字段中文名称<br>**示例值**："账号token"
en_us | string | 否 | 自定义字段英文名称<br>**示例值**："Account token"
is_required | boolean | 是 | 是否必填。<br>**可选值有**：<br>* `true`：必填<br>* `false`：非必填<br>**示例值**：true
description | i18n | 否 | 自定义字段的描述。用户在「飞书招聘」-「设置」-「生态对接」-「笔试/背景调查」下添加账号时看到的控件提示信息
zh_cn | string | 否 | 中文名称<br>**示例值**："账号的唯一标识，可联系客服获取"
en_us | string | 否 | 英文名称<br>**示例值**："The unique identifier of the account can be obtained by contacting the customer service"

### 请求体示例
```json
{
    "scope": 1,
    "custom_field_list": [
        {
            "key": "account_token",
            "name": {
                "zh_cn": "账号token",
                "en_us": "Account token"
            },
            "is_required": true,
            "description": {
                "zh_cn": "账号的唯一标识，可联系客服获取",
                "en_us": "The unique identifier of the account can be obtained by contacting the customer service"
            }
        }
    ]
}
```

## 响应

### 响应体

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

### 响应体示例
```json
{
    "code": 0,
    "msg": "ok",
    "data": {}
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)