Skip to main content
POST
Import or safely replay a historical appointment

Path Parameters

accountId
integer
required

HueChat account ID

Body

application/json

Historical appointment

external_id
string
required
Required string length: 1 - 128
Example:

"ehr-appointment-10492"

status
enum<string>
required
Available options:
tentative,
booked,
confirmed,
completed,
cancelled,
no_show,
proposed,
pending,
waitlist,
arrived,
checked-in,
fulfilled,
noshow
Example:

"fulfilled"

cancellation_reason
string
Example:

"Cancelled in source system"

contact_id
integer
Example:

42

customer_email
string
Example:

"customer@example.com"

customer_name
string
Example:

"Example Customer"

customer_phone
string
Example:

"+966500000000"

date
string
Example:

"2025-09-15"

deal_id
string<uuid>
Example:

"00000000-0000-4000-8000-000000000003"

ends_at
string<date-time>
Example:

"2025-09-15T09:30:00Z"

notes
string
Example:

"Imported from the prior EHR"

resource_id
string<uuid>
Example:

"00000000-0000-4000-8000-000000000001"

resource_name
string
Example:

"Dr. Sara"

service_id
string<uuid>
Example:

"00000000-0000-4000-8000-000000000002"

service_name
string
Example:

"Initial consultation"

source_system
string
Example:

"clinic-ehr"

starts_at
string<date-time>
Example:

"2025-09-15T09:00:00Z"

status_changed_at
string<date-time>
Example:

"2025-09-15T09:35:00Z"

time
string
Example:

"12:00"

Response

Identical idempotent replay

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