Appointment Cancel Reason

The Appointment Cancel Reason Reference is a list of cancellation reasons. When the user cancels an appointment a reason has to be specified for cancellation.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Endpoints

Reference

GET

Get list of appointment cancellation
reasons

Get list of appointment cancellation reasons

GET

/v1/{practiceid}/appointmentcancelreasons

Retrieves the list of reasons for cancelling a scheduled appointment

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

slotavailable boolean Only return values with slotavailable matching this boolean.

limit integer Number of entries to return (default 100, max 5000)Please note that this endpoint has a different default than normal.

offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all

appointmentcancelreasonid integer The cancel reason ID.

name string The reason for cancellation.

noshow string The patient was a no-show.

patientrescheduled string The patient rescheduled this appointment.

providerunavailable string The provider is unavailable for this appointment.

slotavailable string If true, using this cancel reason will create a new appointment slot at the same time as the original appointment.

Example Code