Skip to main content
POST
Create Entity Type Field

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
entityTypeId
string

The entity type to create the field on (required).

key
string | null

The unique key for the field. If omitted, derived from the name.

name
string

The display name of the field (required).

dataType
enum<string>

The data type of the field (required).

Available options:
DATA_TYPE_UNSPECIFIED,
TEXT,
NUMBER,
BOOL,
TIMESTAMP,
ENUM,
ENTITY_REF,
USER_REF,
UNIQUE,
MULTI_SELECT,
FILE,
TICKET_REF,
TIMESTAMP_RANGE
enumOptions
EnumOptionInput · object[]

Options for ENUM / MULTI_SELECT fields (required for those data types).

isKeyField
boolean

Whether this field is the entity type's key (dedup identity) field.

isNameField
boolean

Whether this field is the entity type's display-name field.

refEntityTypeId
string | null

For ENTITY_REF fields: the single allowed target entity type. Ignored when ref_entity_type_ids is non-empty; prefer that field.

refEntityTypeIds
string[]

For ENTITY_REF fields: the entity types values may reference. Empty falls back to ref_entity_type_id; both empty means any type.

Response

200 - application/json

Success

data
data · object

Reference to the (COMPLETED) create migration; its details.create_field.field_id is the new field id.