Skip to main content
PUT
Update custom field

Authorizations

X-API-KEY
string
header
required

Path Parameters

custom_field_id
integer
required

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

OK

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 July 13, 2026