Skip to main content
Create Custom Entity
curl --request POST \
  --url https://integration.getmateo.com/api/v1/custom_entity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_entity_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "data": {},
  "custom_entity_definition_key": "<string>"
}
'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_entity_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "data": {}
}

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

​
id
string<uuid>
default:random uuid

Entity 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

​
custom_entity_definition_id
string<uuid>

Custom entity definition ID

​
contact_id
string<uuid>

Contact ID

​
external_id
string<text> | null

External ID

​
data
object

Entity data matching the custom entity definition schema

​
custom_entity_definition_key
string<text>

Key of the custom entity definition. Alternative to custom_entity_definition_id.

Response

The updated Custom Entity object

​
id
string<uuid>
default:random uuid

Entity 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

​
custom_entity_definition_id
string<uuid>

Custom entity definition ID

​
contact_id
string<uuid>

Contact ID

​
external_id
string<text> | null

External ID

​
data
object

Entity data matching the custom entity definition schema