Sign in
Calendar Events

Deletes a calendar event.

  • If the event to delete is recurring, deleteAllRecurring must be specified:
    • If deleteAllRecurring is true, all future occurrences of the event are deleted
    • If deleteAllRecurring is false, an optional deleteOnDate can be provided.
      • if deleteOnDate is provided, the event is split and the event is only deleted on the specified date and previous or future events are not deleted.
      • if the deleteOnDate is not provided, this is set to the event's startTime value.
  • If the event to delete is assigned to a group, deleteAllGrouped must be specified:
    • If deleteAllGrouped is true, all events in the group are deleted otherwise only the current event is deleted.
delete/calendarEvents/{calendarEventId}

Path parameters

calendarEventIdinteger required

Request body

deleteOnDatestring date-time nullable
deleteAllRecurring'TRUE' | 'FALSE' nullable
deleteAllGrouped'TRUE' | 'FALSE' nullable

Example request

{
  "deleteOnDate": "2021-01-01T07:00:00.000Z"
}

Response

Calendar event deleted successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.