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 staff member to a Wix user.

By default the staff member's email is used to connect to the user. If the email is already associated with a Wix user with roles and permissions to access the site, the staff member is connected to that user. If the email is not associated with a Wix user, or the Wix user is not associated with the site, an invitation is sent to the email to join the site.

Connecting a staff member to a user gives access to the user to manage the staff's schedule via the Wix backoffice.

The status of a staff member's connection is stored in the associatedWixIdentity field, and can be fetched using the requested field ASSOCIATED_IDENTITY_STATUS.

The status of a connection can be one of the following:

  • CONNECTED - The staff member is connected to a Wix user.
  • PENDING - An invitation was sent to the user to connect to the staff member.
  • EXPIRED - The invitation to connect to the staff member has expired.
  • DISCONNECTED - The staff member is not connected to a user.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
staffMemberIdstringRequired

ID of the staff member. The staff member to connect to a user.


optionsConnectStaffMemberToUserOptions

Options for connecting the staff member to a Wix user.

Returns
Return Type:Promise<ConnectStaffMemberToUserResponse>
Did this help?