Skip to main content
PUT
Sync one appointment from a scheduling system

Authorizations

Authorization
string
header
required

Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.

Path Parameters

accountId
integer
required

HueChat account ID

externalId
string
required

The scheduling system's booking identifier

Body

application/json

Booking as the scheduling system has it

cancellation_reason
string
contact_id
integer
Example:

42

customer_email
string
Example:

"patient@example.com"

customer_name
string
Maximum string length: 200
Example:

"Example Patient"

customer_phone
string
Example:

"+966500000000"

date
string
Example:

"2026-09-22"

duration_minutes
integer
Required range: 1 <= x <= 43200
ends_at
string<date-time>
Example:

"2026-09-22T13:20:00+03:00"

external_id
string
Maximum string length: 128
Example:

"oracle-main:A-10492"

notes
string
patient_identifier
string
Maximum string length: 255
Example:

"MRN-000205"

resource_code
string
Maximum string length: 128
Example:

"Practitioner/482"

resource_id
string<uuid>
resource_name
string
Maximum string length: 160
Example:

"Dr. Sara Ali"

resource_type
string
Maximum string length: 80
Example:

"Doctor"

service_code
string
Maximum string length: 128
Example:

"DENT-CONSULT"

service_id
string<uuid>
service_name
string
Maximum string length: 160
Example:

"Dental consultation"

source_updated_at
string<date-time>
Example:

"2026-09-22T09:58:00Z"

starts_at
string<date-time>
Example:

"2026-09-22T13:00:00+03:00"

status
string
Example:

"booked"

time
string
Example:

"13:00"

Response

Updated, unchanged or stale (see X-HueChat-Sync-Result)

account_id
integer
buffer_after_minutes
integer
buffer_before_minutes
integer
busy_ends_at
string<date-time>
busy_starts_at
string<date-time>
cancellation_reason
string
cancelled_at
string<date-time>
completed_at
string<date-time>
confirmed_at
string<date-time>
contact_id
integer
conversation_id
integer
created_at
string<date-time>
created_by_ai_agent_id
string<uuid>
created_by_user_id
integer
customer_email
string
customer_name
string
customer_phone
string
duration_minutes
integer
ends_at
string<date-time>
external_id
string
id
string<uuid>
notes
string
public_id
string
resource_color
string
resource_id
string<uuid>
resource_name
string
resource_type
string
service_color
string
service_currency
string
service_description
string
service_id
string<uuid>
service_name
string
service_price
number
source
string
starts_at
string<date-time>
status
string
updated_at
string<date-time>
version
integer