Create 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.

Creates a custom field for your organization. The field is scoped to the organization resolved from your API key; any organizationId in the body is ignored. fieldKey must be unique among your active fields, and type is fixed once created. When hasFixedOptions is true, allowedValues is required and non-empty; when false, allowedValues must be empty or omitted.

Capacity: there is a maximum number of fields per type, and deleting a field does not free that capacity (deletes are permanent). Provision fields deliberately. A create that exceeds the limit for a type returns 400.

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

The custom field to create

Request body for creating a custom field.

string
required
length between 1 and 255

Your stable key for the field. Must be unique among the organization's active fields.

string
required
length between 1 and 255

Human-readable display name for the field.

string
enum
required

The field's data type. Cannot be changed after creation.

Allowed:
boolean
required

When true, allowedValues is required and non-empty (a dropdown). When false, allowedValues must be empty or omitted.

allowedValues
array of strings

The permitted values. Required and non-empty when hasFixedOptions is true; must be empty or omitted 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