Skip to main content
Update Appointment Details
curl --request PATCH \
  --url https://integration.getmateo.com/api/v1/appointment_details \
  --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",
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "status_key": "<string>",
  "type_key": "<string>",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": "<string>",
  "end_time": "<string>",
  "confirmed_at": "<string>",
  "cancelled_at": "<string>"
}
'
{
  "id": "random uuid",
  "created_at": "now()",
  "updated_at": "now()",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "status_key": "<string>",
  "type_key": "<string>",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": "<string>",
  "end_time": "<string>",
  "confirmed_at": "<string>",
  "cancelled_at": "<string>"
}

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
required
​
created_at
string
​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
name
string

Name of the appointment

​
description
string

Description of the appointment

​
external_id
string
required

External ID

​
status_key
string

Status Key

​
type_key
string

Type Key

​
assignee_id
string

Assignee ID

​
contact_id
string
​
start_time
string

Start time of the appointment

​
end_time
string

End time of the appointment

​
confirmed_at
string

Confirmed at timestamp

​
cancelled_at
string

Cancelled at timestamp

Body

application/json

appointment

​
id
string<uuid>
default:random uuid
​
created_at
string<timestamp with time zone>
default:now()
​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
name
string<text>

Name of the appointment

​
description
string<text> | null

Description of the appointment

​
external_id
string<text> | null

External ID

​
status_key
string<text>

Status Key

​
type_key
string<text>

Type Key

​
assignee_id
string<uuid> | null

Assignee ID

​
contact_id
string<uuid>
​
start_time
string<timestamp with time zone>

Start time of the appointment

​
end_time
string<timestamp with time zone> | null

End time of the appointment

​
confirmed_at
string<timestamp with time zone> | null

Confirmed at timestamp

​
cancelled_at
string<timestamp with time zone> | null

Cancelled at timestamp

​
{key}
Example:

"your string custom field"

Response

The updated Appointment object

​
id
string<uuid>
default:random uuid
​
created_at
string<timestamp with time zone>
default:now()
​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
name
string<text>

Name of the appointment

​
description
string<text> | null

Description of the appointment

​
external_id
string<text> | null

External ID

​
status_key
string<text>

Status Key

​
type_key
string<text>

Type Key

​
assignee_id
string<uuid> | null

Assignee ID

​
contact_id
string<uuid>
​
start_time
string<timestamp with time zone>

Start time of the appointment

​
end_time
string<timestamp with time zone> | null

End time of the appointment

​
confirmed_at
string<timestamp with time zone> | null

Confirmed at timestamp

​
cancelled_at
string<timestamp with time zone> | null

Cancelled at timestamp

​
{key}
Example:

"your string custom field"