Sign in

v4

latestOpenAPI 3.1.02026-08-031873791.4 MB
Custom Fields

Update custom field

Update an existing custom field definition. applies_to and company_ids are replaced wholesale — send the full desired list. field_type cannot be changed after creation.

put/public/v1/custom-fields/{custom_field_id}/

Path parameters

custom_field_idinteger required

Request body

namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
company_idinteger nullable

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

company_idsinteger[] nullable

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

is_activeboolean
optionsstring[] nullable

Allowed values for single_select / multi_select fields

Response

OK

idinteger required
company_idinteger nullable
company_idsinteger[]
namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
optionsstring[] nullable
is_activeboolean required