POST

Cancel Schedule


Deprecated

This method has been replaced with Cancel Schedule, and will be removed on June 30, 2025.

Cancels a schedule. Equivalent to batch cancel of sessions linked to a single schedule. The schedule changes to status = CANCELED - all sessions up until the time of cancellation are kept, and all future sessions are removed.

Permissions This endpoint requires the Manage Bookings permissions scope

Endpoint
POST
https://www.wixapis.com/bookings/v1/calendar/schedules/{scheduleId}/cancel

Path Params
scheduleIdstringRequired

Schedule ID.

Body Params
fromstringformat date-time

Time to cancel the sessions from. Optional. If this field is empty, all of this schedule's sessions will be canceled.


preserveFutureSessionsWithParticipantsboolean

Whether to preserve future sessions with reservations. Defaults to false.


notifyParticipantsbooleandeprecated

Deprecated, use participant_notification


participantNotificationParticipantNotification

Whether to notify participants about the change, and an optional custom message.

Response Object
scheduleSchedule

Schedule.

Cancel a schedule without notifying participants

Request
cURL
curl -X POST \ 'https://www.wixapis.com/bookings/v1/calendar/schedules/03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "schedule": { "id": "03d67e9c-5ba9-4e73-ad9e-7fddc57c6c4e", "scheduleOwnerId": "9b33d0b6-bcd2-408b-ac9d-f164504a16e2", "firstSessionStart": "2019-08-19T11:00:00Z", "lastSessionEnd": "2019-08-26T12:00:00Z", "timeZone": "America/Denver", "intervals": [ { "id": "41f2f68b-9543-42b2-911b-cd98e5463ec1", "start": "2019-08-18T21:00:00Z", "end": "2019-08-26T20:59:59.999Z", "interval": { "daysOfWeek": "MON", "hourOfDay": 14, "minuteOfHour": 0, "duration": 60 }, "frequency": { "repetition": 1 }, "affectedSchedules": [ { "scheduleId": "dc9585a4-a613-46fc-a229-59923efe08c6", "transparency": "BUSY", "scheduleOwnerId": "5460647f-ff8f-45f7-8311-a3aef2d8e9e8" } ] } ], "title": "Intermediate Ski Lesson (members only)", "tags": [ "GROUP" ], "location": { "locationType": "OWNER_BUSINESS" }, "capacity": 50, "rate": { "labeledPriceOptions": {
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?