Sign in

34b7cf5b4b6c

latestOpenAPI 3.1.02026-08-122324681.8 MB
Custom Fields

Create custom field

Create a new custom field definition. Supply applies_to to bind the field to record types, and company_ids (or company_id) to restrict it to specific companies.

post/public/v2/custom-fields/

Headers

Idempotency-Keystring

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.

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

Created

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