assignWorkingHoursSchedule( )

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 staff member's working hours based on the specified schedule ID (SDK | REST).

Default working hours

By default, staff members work during the opening hours of the business's default location (SDK | REST).

Schedule ID

You can specify either the ID of the business's working hour schedule or the staff member's event schedule. The call fails if you specify a different schedule ID.

Staff event schedule

To customize a staff member's working hours, specify their event schedule ID as scheduleId. Refer to this sample flow (SDK | REST) for more details.

Business working hour schedule

To reset a staff member’s working hours to the default business hours, specify the ID of the business working hour schedule as scheduleId.

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 to assign the schedule to.

scheduleIdstringRequired

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

Must be either the staff member's event schedule ID or the working hour schedule ID for a business location.

optionsAssignWorkingHoursScheduleOptions

Options for setting the staff member's working hours schedule.

Returns
Return Type:Promise<AssignWorkingHoursScheduleResponse>
JavaScript
Errors

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

Did this help?