Create client field

Create a new client field in the account.

Authorization

authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

Client field params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a client field

description?|

An optional description of the field.

key*string

The machine-readable key for the field.

label*string

The human-readable label for the field.

options?

Options for choice-type client fields.

sensitive?boolean

Whether the field contains sensitive data.

type*string

The field type.

Value in

"short_text"
"long_text"
"email"
"phone"
"boolean"
"radio"
"select"
"checkbox"

Response Body

`application/json`

curl -X POST "https://example.com/v1/client_fields" \  -H "Content-Type: application/json" \  -d '{    "key": "company_name",    "label": "Company Name",    "type": "short_text"  }'

{  "data": {    "created_at": "2024-01-01T00:00:00Z",    "description": null,    "id": "cf_a1b2c3d4e5f6",    "key": "company_name",    "label": "Company Name",    "object": "client_field",    "options": null,    "sensitive": false,    "sort_order": 1,    "type": "short_text",    "updated_at": "2024-01-01T00:00:00Z"  }}

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`