Sign in
Custom Fields

Update a custom field

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

Updates an existing custom field

put/v3/custom-fields/{id}

Path parameters

idinteger required

Custom field ID

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)

Response

Custom field updated 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

Changes