POST

Cancel Schedule


Developer Preview

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

Sets a schedule's status to CANCELLED.

Also cancels future events belonging to the schedule.

Once a schedule is marked as CANCELLED, you can't reactivate it, update it, or assign new events.

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/schedules/{scheduleId}/cancel

Path Params
scheduleIdstringRequired

ID of the schedule to cancel.

Body Params
preserveFutureEventsWithParticipantsboolean

Whether to preserve future events with participants. Default: false.


participantNotificationParticipantNotification

Information about whether participants of the schedule's updated events are notified and the message they receive.

Response Object
scheduleSchedule

Canceled schedule.

Request
cURL
Response
JSON
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

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