updateSchedule( )


Developer Preview

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

Updates a schedule.

Each time the schedule is updated, revision increments by 1. The current revision must be passed when updating the schedule. This ensures you're working with the latest schedule and prevents unintended overwrites.

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 updateSchedule(
  _id: string,
  schedule: UpdateSchedule,
  options: UpdateScheduleOptions,
): Promise<Schedule>;
Method Parameters
_idstringRequired

Schedule ID.


scheduleUpdateScheduleRequired

optionsUpdateScheduleOptions
Returns
Return Type:Promise<Schedule>
JavaScript
import { schedules } from "@wix/calendar"; async function updateSchedule(id, schedule, options) { const response = await schedules.updateSchedule(id, schedule, 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?