Update a custom field

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

Important Notes:

  • Field name and fieldType cannot be changed after creation
  • 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
}
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

Which entities this field applies to

Allowed:
boolean

Whether this field is required

string | null

Default value for new records

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)

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