Cancel an appointment
cancel_appointmentCancel an appointment and automatically notify attendees. For group bookings, remove a single attendee or cancel the entire appointment, including recurring series.
Instructions
Cancel an appointment and notify attendees. For a group booking, attendeeId removes one person while cancelAll cancels the whole appointment. Requests with neither are rejected. The response distinguishes attendee_removed from cancelled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Included in the notification emails to participants | |
| cancelAll | No | Cancel the entire appointment | |
| attendeeId | No | Remove a single attendee | |
| appointmentId | Yes | ||
| cancelEntireSeries | No | For a recurring appointment, cancel every occurrence |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| status | No | ||
| bookingState | No | ||
| removedAttendeeId | No | Set when a single attendee was removed |