Skip to main content
Update Custom Entity Definition
curl --request PATCH \
  --url https://integration.getmateo.com/api/v1/custom_entity_definition \
  --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",
  "key": "<string>",
  "name": "<string>",
  "schema": {}
}
'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "name": "<string>",
  "schema": {}
}

Authorizations

Authorization
string
header
required

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

Query Parameters

select
string

Select columns to return

id
string

Custom entity definition ID

created_at
string

Creation date

updated_at
string

Latest update

organisation_id
string

Organisation ID

key
string

Unique key for the custom entity definition

name
string

Name of the custom entity definition

schema
string

JSON Schema defining the custom entity data structure

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