Skip to main content
POST
Create a field on an entity definition

Authorizations

Authorization
string
header
required

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

Path Parameters

project
string
required

The project slug

entity
string
required

The entity slug

Body

application/json
name
string
required
Maximum string length: 255
type
enum<string>
required
Available options:
text,
multiline,
number,
boolean,
date,
enum,
reference,
currency,
phone,
email,
json
key
string | null
Maximum string length: 63
Pattern: ^[a-z0-9_]+$
constraints
string[] | null
phi_flag
boolean | null
indexed
boolean

Build a database index on this field so Data API filters and sorts on it are index-served. Bounded types only, and a capped number per entity and per org — see EntityIndexPolicy.

position
integer | null
Required range: x >= 0

Response

data
any[]
required