API ReferenceCustom Field Definitions

Update Custom Field Definition

View as Markdown

Update a custom field definition.

Only display_name, description, and constraints can be updated. The field_key, data_type, and entity_type are immutable.

For select fields, you can add new options but cannot remove options that are in use.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

The custom field definition ID (e.g., ‘cfd_dev_abc123’)

account_idstringRequired

Request

This endpoint expects an object.
display_namestring or nullOptional1-255 characters

Human-readable name for the field

descriptionstring or nullOptional
Optional description explaining the field's purpose
constraintsmap from strings to any or nullOptional

Type-specific constraints. For select fields, you can add options but cannot remove options that are in use.

is_visible_in_listboolean or nullOptional
Whether this field appears as a column in list views

Response

Successful Response
idstring

Unique identifier for the definition (e.g., ‘cfd_dev_abc123’)

field_keystring
The key used when setting values on entities
entity_typeenum
The entity type this field applies to
data_typeenum
The data type for values
display_namestring

Human-readable name for the field

is_visible_in_listboolean
Whether this field appears as a column in list views
created_atdatetime
When the definition was created
updated_atdatetime
When the definition was last updated
descriptionstring or nullOptional
Optional description of the field
constraintsmap from strings to any or nullOptional

Type-specific constraints

Errors

422
Unprocessable Entity Error