Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Custom Entities

Create Custom Entity

POST
/v1/custom-entities

Creates a new custom Entity.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

custom_entity_definition_id?string

The definition whose JSON Schema validates this custom entity.

Formatuuid
contact_id*string

The contact this custom entity belongs to.

Formatuuid
external_id?|

An optional identifier from an external system.

data?

Structured JSON data for this resource or response.

custom_entity_definition_key?string

Stable key used to identify the definition.

Response Body

application/json

curl -X POST "https://api.getmateo.com/v1/custom-entities" \  -H "Content-Type: application/json" \  -d '{    "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "custom_entity_definition_id": "7d69c76b-fbd6-4171-a3bd-6ed8ca83d88f",  "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",  "external_id": "string",  "data": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}