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
Update Event
instead, as this preserves past events and only modifies future events.
The main consequences are:
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.MASTER event is created, starting from the first event that
begins after splitLocalDate.INSTANCE and EXCEPTION events that occur after the split are updated.
Their recurringEventId is set to the ID of the newly created MASTER event.You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.