Skip to main content
Create Custom Entity Definition

Authorizations

Authorization
string
header
required

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

Query Parameters

select
string

Filtering Columns

Body

application/json

custom_entity_definition

id
string<uuid>
default:random uuid

Custom entity definition ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

key
string<text>

Unique key for the custom entity definition

name
string<text>

Name of the custom entity definition

schema
object

JSON Schema defining the custom entity data structure

Response

The updated Custom Entity Definition object

id
string<uuid>
default:random uuid

Custom entity definition ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

key
string<text>

Unique key for the custom entity definition

name
string<text>

Name of the custom entity definition

schema
object

JSON Schema defining the custom entity data structure