Skip to main content
POST
Create custom field

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Body

application/json
name
string
required
Required string length: 2 - 32
field_type
enum<string>
required
Available options:
text,
number,
currency,
date,
boolean,
single_select,
multi_select,
link,
paragraph
applies_to
AppliesToItemSchema · object[]
required
description
string | null
helper_text
string | null
default_value
company_id
integer | null

Single company id this custom field is scoped to (merged into company_ids). Omit for an org-wide field.

company_ids
integer[] | null

List of company ids this custom field is scoped to. Omit for an org-wide field.

is_active
boolean
default:true
options
string[] | null

Allowed values for single_select / multi_select fields

Response

Created

id
integer
required
name
string
required
field_type
enum<string>
required
Available options:
text,
number,
currency,
date,
boolean,
single_select,
multi_select,
link,
paragraph
is_active
boolean
required
company_id
integer | null
company_ids
integer[]
description
string | null
helper_text
string | null
applies_to
AppliesToItemSchema · object[]
default_value
options
string[] | null
Last modified on August 21, 2026