Update a custom field (Beta)

Beta. You can define and manage custom fields now. Populating candidate values and filtering or searching by them arrives in a later release.

Updates a custom field's label, hasFixedOptions and/or allowedValues. 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). 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
Responses

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