assignCustomSchedule( )

Deprecated

This method has been replaced with Assign Working Hours Schedule, and will be removed on December 31, 2024.

Assigns a custom working hours schedule to the staff member

The working hours schedule is a schedule that defines the working hours of a staff member, and dictate when the staff member is available for bookings.

By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member, you can define specific working hours for that staff member.

To create and manage schedules and working hours sessions, use Events API.

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
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
staffMemberIdstringRequired

ID of the staff member for which to assign a working hour schedule.

scheduleIdstringRequired

ID of the schedule (SDK | REST) to assign to the staff member.

optionsAssignCustomScheduleOptions
Returns
Return Type:Promise<AssignCustomScheduleResponse>
JavaScript
Errors

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

Did this help?