cancelSchedule( )


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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
scheduleIdstringRequired

ID of the schedule to cancel.


optionsCancelScheduleOptions
Returns
Return Type:Promise<CancelScheduleResponse>
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?