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
curl -X POST \ 'https://www.wixapis.com/calendar/v3/schedules/3470efd4-bd31-4aab-b339-38cdce8e1bd2/cancel' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "schedule": { "id": "3470efd4-bd31-4aab-b339-38cdce8e1bd2", "externalId": "c84d2eb2-925e-49d8-910a-280473629415", "name": "Zumba", "status": "CANCELLED", "timeZone": "Europe/Dublin", "businessTimeZoneEnabled": true, "defaultTitle": "Zumba", "defaultCapacity": 10, "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "2", "createdDate": "2024-10-07T06:51:20.019Z", "updatedDate": "2024-10-07T06:53:43.510Z" } }
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?