REST API Developer Guide

Introducing Lightning Platform REST API
Quick Start
Examples
Getting Information About My Organization
Working with Object Metadata
Working with Records
Delete Lightning Experience Event Series
Working with Searches and Queries
Insert or Update Blob Data
Working with Recently Viewed Information
Managing User Passwords
Working with Approval Processes and Process Rules
Using Event Monitoring
Using Composite Resources
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Delete Lightning Experience Event Series

Use the HTTP DELETE method to remove one or more IsRecurrence2 events in a series. You can remove a single event, all events following and including a specific event, or an entire event series.

Deleting a Single Event in a Series

Use the SObject Rows resource to delete event records. To delete a single occurrence in a series, specify the event ID and use the DELETE method of the resource to delete a record.

Delete from an Event Onwards

To delete all events in a series from a specific occurrence and onwards, specify the event ID and use the DELETE method of the resource to delete a record. When calling this method, IsRecurrence2 must be true and IsRecurrence2Exclusion must be false.

Example for deleting from an event onwards
Example request body
Example response body after successfully deleting events from the series

Delete All Events in a Series

To delete an entire event series, specify the event ID of the first occurrence in the series and use the DELETE method of the resource to delete a record.

Example for deleting an entire series
Example request body
Example response body after successfully deleting events from the series

Considerations

Delete from an Event Onwards does not support calls from events that:
  • Occurred before the original value of Recurrence2PatternStartDate.
  • Are defined as child events.

If the event series originated outside of Salesforce and the event ID of the first occurrence is unavailable, you can’t delete all events in a series. Instead, delete events from a specific occurrence onwards.