Delete an appointment
delete_appointmentDelete an appointment. Returns true on success; errors if the id is not on the (year, month) page. A recurring series (recurring: true in get_calendar) needs scope: 'this' removes only the occurrence on occurrence_day…
Instructions
Delete an appointment. Returns true on success; errors if the id is not on the (year, month) page. A recurring series (recurring: true in get_calendar) needs scope: 'this' removes only the occurrence on occurrence_day, 'this_and_following' ends the series before it, 'series' removes every occurrence, past and future. Confirm a 'series' delete with the user first. Holidays, subscribed calendars and birthdays cannot be deleted.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| year | Yes | ||
| month | Yes | ||
| scope | No | Required for a recurring series: 'this' = only the occurrence on occurrence_day, 'this_and_following' = that occurrence and every later one, 'series' = every occurrence. | |
| notify | No | Send Cozi's change notification to the attendees who have notifications on, like the Cozi app's 'notify' option. Off by default; only when the user asks for it. | |
| appointment_id | Yes | ||
| occurrence_day | No | With scope 'this' or 'this_and_following': the occurrence's `day` as get_calendar lists it. |