Update a custom field

Update an existing custom field. You can update the label, description, required status, field type, and choices.

Important Notes:

  • Field name cannot be changed after creation
  • fieldType can be changed only when every non-empty stored value is already valid for the new type
    (values are never converted). Any type change is allowed on a field with no values. Otherwise the
    request fails with 422; typeChange reports how many values fail, out of how many, plus a
    sample of records and values to fix or clear first.
  • When changing to dropdown or multi_select, send choices in the same request — stored values
    are checked against them
  • currency exists only on contract-type fields
  • When updating choices for dropdown or multi_select fields, provide the complete new array
  • Changing appliesTo will affect which entities can use this field

Common Updates:

Update Label:

{
  "label": "Updated Label"
}

Update Dropdown Choices:

{
  "choices": ["New Option 1", "New Option 2", "New Option 3"]
}

Make Field Required:

{
  "required": true
}

Change a Text Field of Links to URL:

{
  "fieldType": "url"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Custom Field ID

Body Params
string

Display label

string
enum

New field type. Allowed only when every non-empty stored value is valid for it (any change is allowed on a field with no values).

Allowed:
string
enum

Which entities this field applies to

Allowed:
boolean

Whether this field is required

string | null
deprecated

Deprecated. Never stored; always null. Will be removed.

string | null

Help text or description

choices
array of strings

Options for dropdown and multi_select fields

choices
boolean

Whether this date field is treated as recurring (e.g., birthdays, anniversaries)

string | null

Display format for number fields (e.g., "currency", "percentage")

Responses
200

custom field updated

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json