splitRecurringEvent( )

Splits a recurring MASTER event into 2 separate MASTER events.

You must provide a splitLocalDate that's in the future and after the start date of the next INSTANCE or EXCEPTION event in the series. Additionally, there must be another INSTANCE or EXCEPTION event following this next event, as the changes wouldn't affect any event without a subsequent occurrence.

If you want to modify a MASTER event with the changes already applying to the very next event, use updateEvent() instead, as this preserves past events and only modifies future events.

The main consequences are:

  • The original MASTER event is shortened. Its recurrenceRule.until.localDate is updated to end.localDate of the latest INSTANCE or EXCEPTION event starting before splitLocalDate. If an INSTANCE or EXCEPTION event starts before but ends after splitLocalDate, until.localDate is set to value that's later than splitLocalDate.
  • A new MASTER event is created, starting from the first event that begins after splitLocalDate.
  • Existing INSTANCE and EXCEPTION events that occur after the split are updated. Their recurringEventId is set to the ID of the newly created MASTER event.
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
recurringEventIdstringRequired

ID of the MASTER event to split.

splitLocalDatestringRequired

Local date and time at which the MASTER event is split in ISO-8601 format. For example, 2025-03-11T09:00:00. Must be a future date that's after the start date of the next INSTANCE or EXCEPTION event in the series. Additionally, there must be another INSTANCE or EXCEPTION event following this next event, as the changes wouldn't affect any event without a subsequent occurrence.

optionsSplitRecurringEventOptions
Returns
Return Type:Promise<SplitRecurringEventResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?