connectStaffMemberToUser( )

Developer Preview

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

Connects a Wix user to a staff member, enabling them to manage their own working hour schedule in the dashboard.

By default, Wix Bookings uses the staff member's email. However, you can specify an alternative email address. If no existing Wix user is associated with that email, Wix sends them an invitation to become a Wix user. If an existing user is found but not linked to the site, Wix Bookings sends an invitation to join the site.

To check the connection status, call Get Staff Member (SDK | REST), and specify ASSOCIATED_IDENTITY_STATUS in the fields parameter.

You must call Disconnect Staff Member From User (SDK | REST) before connecting a different Wix user to the staff member.

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 connect to the Wix user.

optionsConnectStaffMemberToUserOptions

Options for connecting the staff member to a Wix user.

Returns
Return Type:Promise<ConnectStaffMemberToUserResponse>
Errors

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

Did this help?