Create Custom Field
curl --request POST \
  --url https://integration.getmateo.com/api/v1/custom_field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "random uuid",
  "name": "<string>",
  "description": "<string>",
  "type": "string",
  "key": "<string>",
  "entity": "contact"
}'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "random uuid",
  "name": "<string>",
  "description": "<string>",
  "type": "string",
  "key": "<string>",
  "entity": "contact"
}

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_field

id
string<uuid>
default:random uuid

Custom field ID

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

Custom field creation date

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

Latest update

organisation_id
string<uuid>
default:random uuid

Organisation ID

name
string<text>

Name of custom field

description
string<text> | null

Custom field description

type
enum<string>

Typ of custom field

Available options:
string,
datetime,
boolean,
number,
date,
string_list
key
string<text>

Custom field key

entity
enum<string>
default:contact
Available options:
contact,
deal,
appointment

Response

The updated Custom Field object

id
string<uuid>
default:random uuid

Custom field ID

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

Custom field creation date

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

Latest update

organisation_id
string<uuid>
default:random uuid

Organisation ID

name
string<text>

Name of custom field

description
string<text> | null

Custom field description

type
enum<string>

Typ of custom field

Available options:
string,
datetime,
boolean,
number,
date,
string_list
key
string<text>

Custom field key

entity
enum<string>
default:contact
Available options:
contact,
deal,
appointment