Skip to Content
MosaicMosaicDocs
Tool Reference

DeleteCalendarEvent

Delete an event from the user's calendar.

Starter documentation. Features and account details may differ from this deployment.

DeleteCalendarEvent

Delete an event from the user's calendar.

A meeting on more than one of the user's inboxes is one ListCalendarEvents entry per inbox. Before deleting any of them, ask the user which inbox's copy to delete, then pass that copy's inbox. Never choose between the user's inboxes yourself, whatever they look like: a test, secondary or unfamiliar address is still the user's own inbox. Skip the question only when the user already named the inbox, or when only one copy can be deleted (isReadOnly false); then delete that copy and say why. Without inbox the tool refuses, lists each copy and gives the question to ask. Deleting the copy the user organizes cancels the meeting for every guest. Deleting a copy where they are a guest takes the meeting off that inbox's calendar: on Google it also declines the invitation and tells the organizer, while on Outlook the organizer is not told and still sees the invitation unanswered.

The deletion is written to the calendar provider immediately and attendees are notified, so confirm with the user before deleting — it cannot be undone. Get the eventId from ListCalendarEvents.

For recurring events, scope controls how much is removed: "all" (default) removes the whole series, "this_event" removes one occurrence, and "this_and_following" ends the series from an occurrence onward. The scoped variants require recurrenceId from the targeted occurrence's ListCalendarEvents entry.

Parameters

ParameterTypeRequiredDescription
eventIdstringYesThe event's id, from ListCalendarEvents or CreateCalendarEvent.
calendarIdstringNoThe calendarId of the copy to delete, from the copies of its ListCalendarEvents entry, for an event synced from more than one calendar. Omit to delete the event's primary copy.
inboxstringNoThe inbox of the copy to delete, from its ListCalendarEvents entry. Required when the meeting is on more than one of the user's inboxes: the tool refuses without it and lists each copy. It must be the inbox holding the copy eventId names.
scope"all" | "this_event" | "this_and_following"NoHow much of a recurring series a deletion removes.
recurrenceIdstringNoThe recurrenceId of the targeted occurrence, from its ListCalendarEvents entry. Required for "this_event" and "this_and_following".

On this page