Calendar Events

DELETE /calendarEvents/{calendarEventId}

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.

Request

Base URL
https://api.fergus.com
Auth
- OAuth 2
  Authorization codehttps://auth.fergus.com/oauth2/authorize
  Token URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/fergus/apis/fergus-api/docs/calendarEvents/:calendarEventId/delete.ts
A function with typed inputs. Its response is checked against the schema.

calendarEventIdinteger required

deleteOnDatestring date-time nullable

deleteAllRecurring'TRUE' | 'FALSE' nullable

deleteAllGrouped'TRUE' | 'FALSE' nullable

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

Calendar event deleted successfully

No recorded changes to this operation across all 18 revisions of this API.