RXrxfoodapp
cliniko-booking

Cancel a Cliniko appointment

delete/patients/{patient_id}/cliniko/appointments/{appointment_id}

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/cliniko/appointments/{appointment_id}
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required
appointment_idinteger required

Request body

cancellation_reason_code'user_request' | 'schedule_conflict' | 'provider_cancelled' | 'no_show' | 'other' nullable
cancellation_reason_notestring nullable

Response

appointment cancelled

appointment_type_descriptionstring nullable
appointment_type_idinteger nullable
appointment_type_namestring required
appointment_type_sort_orderinteger nullable
assigned_practitioner_idinteger nullable
business_timezonestring nullable
canceled_atstring date-time nullable
cancellation_reasonstring nullable
cliniko_appointment_idinteger required
created_timestring date-time required
duration_minutesinteger required
ends_atstring date-time required
idinteger required
localized_ends_atstring date-time nullable
localized_starts_atstring date-time nullable
province_codestring required
slot_idstring nullable
starts_atstring date-time required
statusstring required
telehealth_urlstring nullable

Changes

No recorded changes to this operation across all 19 revisions of this API.