cancelSchedule( )

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.
Method Declaration
Copy
function cancelSchedule(
  scheduleId: string,
  options: CancelScheduleOptions,
): Promise<CancelScheduleResponse>;
Method Parameters
scheduleIdstringRequired

ID of the schedule to cancel.

optionsCancelScheduleOptions
Returns
Return Type:Promise<CancelScheduleResponse>
JavaScript
import { schedules } from "@wix/calendar";

async function cancelSchedule(scheduleId, options) {
  const response = await schedules.cancelSchedule(scheduleId, options);
}
Errors
428Failed Precondition

There is 1 error with this status code.

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

Did this help?