Update a custom field

Updates a custom field's label, hasFixedOptions, allowedValues and/or displayAs. At least one field must be provided. type is immutable and cannot be changed. hasFixedOptions and allowedValues must stay consistent (a fixed-options field needs non-empty allowedValues; a free-input field must have none), and displayAs: AGE is only valid on a DATE field. A field belonging to another organization, or one that has been deleted, returns 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Custom field id (UUID).

Body Params

Fields to update

Request body for updating a custom field. At least one field must be provided. type is immutable and cannot be updated.

string
length between 1 and 255

New display name for the field.

boolean

Whether values are constrained to allowedValues. Must stay consistent with allowedValues.

allowedValues
array of strings

The permitted values. Must be non-empty when hasFixedOptions is true and empty otherwise.

Allowed Values
string
enum

How the value is displayed. AGE is only valid on a DATE field. Omit to leave unchanged.

Allowed:
Responses

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