v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Custom Fields

Create a custom field

<small>Requires the contacts:write scope (or a broader one that includes it).</small>

Creates a new custom field

post/v3/custom-fields

Request body

titlestring required

Custom field name

fieldType'text' | 'number' required

Custom field type

metadatastring nullable

Optional metadata for the field (e.g., dropdown options)

orgWideboolean

Whether the field should be shared across the organization

Response

Custom field created successfully

idinteger

Custom field ID

titlestring

Custom field name

fieldType'text' | 'number'

Custom field type

metadatastring nullable

Optional metadata for the field (e.g., dropdown options)

orgWideboolean

Whether the field is shared across the organization