Skip to main content
POST
Create a custom field

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Body

application/json
label
string
required

Display label.

Required string length: 1 - 40
Example:

"Tax ID"

key
string
required

Unique key within the workspace. Lowercase letters, digits, and underscores between words only.

Required string length: 1 - 35
Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
Example:

"tax_id"

type
enum<string>
required

Field type. Cannot be changed after the field is created via this parameter, use PATCH to update it.

Available options:
text,
long_text,
select,
multi_select,
cpf,
cnpj,
date,
number,
link,
address
value
object

Options for select and multi_select types. Required when type is select or multi_select. Must be omitted for all other field types.

Example:
required
boolean

Whether the field is required. Defaults to false.

Example:

false

show_people
boolean

Show on people records. Defaults to true.

Example:

true

show_companies
boolean

Show on company records. Defaults to true.

Example:

true

show_deals
boolean

Show on deal records. Defaults to false.

Example:

false

Response

Custom field created successfully.

data
object