Cancel an appointment
splose_cancel_appointmentWRITE: cancels ONE appointment with a cancellation reason (ids from splose_list_cancellation_reasons) and an optional note. The reason's billable rate may create a cancellation charge, and the patient may be notified per the practice's settings. For a group appointment pass patient_id to cancel only that patient's place; without it the whole appointment is cancelled. Cannot be undone through this server: confirm with the user first and pass confirm: true. POST /appointments/{id}/cancellation or /appointments/{id}/patients/{patientId}/cancellation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Optional cancellation note. | |
| confirm | Yes | Must be true: the user has confirmed this cancellation (it may charge a fee and notify the patient). | |
| reasonId | Yes | Cancellation reason id. | |
| patient_id | No | Group appointments only: cancel just this patient's participation. | |
| appointment_id | Yes | Appointment id. |