POST

Split Recurring Event


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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:

  • 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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/calendar/v3/events/{recurringEventId}/split

Path Params
recurringEventIdstringRequired

ID of the MASTER event to split.

Body Params
splitLocalDatestringRequiredformat LOCAL_DATE_TIME

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.


timeZonestring

Time zone in IANA tz database format for calculating adjustedStart and adjustedEnd. For example, America/New_York or UTC.

Default: timeZone specified in the business site properties.

Response Object
updatedRecurringEventEndingBeforeSplitUpdatedRecurringEventEndingBeforeSplit

Original MASTER event that was shortened.


newRecurringEventStartingFromSplitNewRecurringEventStartingFromSplit

New MASTER event starting with the first event after the split date.

Split Recurring Event

Split a recurring event into two events at a specified future date.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/calendar/v3/events/37e01b7f71374c06bca502eb435c150373f9e893914546b795978fe3de3e49f7/split' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "splitLocalDate": "2024-10-11T09:00:00" }'
Response
JSON
{ "updatedRecurringEventEndingBeforeSplit": { "id": "37e01b7f71374c06bca502eb435c150373f9e893914546b795978fe3de3e49f7", "scheduleId": "37e01b7f-7137-4c06-bca5-02eb435c1503", "externalScheduleId": "38e25e56-d50f-42b4-a3b6-aa04c61dded1", "scheduleName": "Full Body Strength", "type": "CLASS", "status": "CONFIRMED", "title": "Full Body Strength", "start": { "localDate": "2024-10-07T09:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T08:00:00Z" }, "end": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T09:00:00Z" }, "adjustedStart": { "localDate": "2024-10-07T09:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "MASTER", "recurrenceRule": { "frequency": "WEEKLY", "interval": 1, "days": ["MONDAY"], "until": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T09:00:00Z" }, "adjustedUntil": { "localDate": "2024-10-07T10:00:00", "timeZone": "Europe/Dublin" } }, "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "e73bf671-bb59-4488-8d1f-afcf0ebe8d27", "transparency": "OPAQUE", "permissionRole": "WRITER" } ], "totalCapacity": 50, "remainingCapacity": 50, "inheritedFields": [ "TITLE", "CAPACITY", "TIME_ZONE", "CONFERENCING_DETAILS" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "2", "createdDate": "2024-10-06T17:16:36.345Z", "updatedDate": "2024-10-07T08:32:09.528Z" }, "newRecurringEventStartingFromSplit": { "id": "37e01b7f71374c06bca502eb435c15032269670344c547169026aaad81152f48", "scheduleId": "37e01b7f-7137-4c06-bca5-02eb435c1503", "externalScheduleId": "38e25e56-d50f-42b4-a3b6-aa04c61dded1", "scheduleName": "Full Body Strength", "type": "CLASS", "status": "CONFIRMED", "title": "Full Body Strength", "start": { "localDate": "2024-10-14T09:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-14T08:00:00Z" }, "end": { "localDate": "2024-10-14T10:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-14T09:00:00Z" }, "adjustedStart": { "localDate": "2024-10-14T09:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-14T10:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "MASTER", "recurrenceRule": { "frequency": "WEEKLY", "interval": 1, "days": ["MONDAY"] }, "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "e73bf671-bb59-4488-8d1f-afcf0ebe8d27", "transparency": "OPAQUE", "permissionRole": "WRITER" } ], "totalCapacity": 50, "remainingCapacity": 50, "inheritedFields": [ "TITLE", "CAPACITY", "TIME_ZONE", "CONFERENCING_DETAILS" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "1", "createdDate": "2024-10-07T08:32:09.521Z", "updatedDate": "2024-10-07T08:32:09.521Z" } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?