Skip to main content
POST
Cancel an appointment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with 409 idempotency_key_conflict, and retrying while the first request is still running with 409 idempotency_key_reused. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required
appointment_id
string<uuid>
required

Body

application/json
reason
string
notify_patient
boolean
default:true

false only ever DOWNGRADES notification columns — never re-enables a row already silenced.

run_automations
boolean
default:false

Response

OK.

data
object
required

Never present here, by name: client_appointment_date/client_start_time/ client_end_time/client_timezone, form_data, custom_color, provider_user_id, time_range, excluded_from_overlap_check, booking_identity_review, provider_busy_minutes, out_of_office_confirmed_at, booking_confirmation_deferred, clinic_id.