createSchedule( )

Developer Preview

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

Creates a schedule.

If you want the schedule's events to appear in the Bookings calendar, you must set appId to the ID of the Wix Bookings app by providing {"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
scheduleScheduleRequired

Schedule to create.

optionsCreateScheduleOptions
Returns
Return Type:Promise<Schedule>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?