About the Site Invites API

The Wix Site Invites API allows you to manage the invitation process for collaborators on a Wix site. Through this API, you can send email invitations to individuals, enabling them to join a site as collaborators with specific roles and permissions.
Learn more about Site Collaborators. Note that site collaborators are managed with the Contributors API.

Use cases

Site invite lifecycle

Site invites progress from creation to assignment through a series of phases, as follows:

  1. Invite created: When Bulk Invite is called, an email invitation is created and sent to each invitee.
  2. Invitee receives email: The invitee receives the invite email.
  3. Invitee responds to invite: The invitee can take one of the following actions:
    • Accept the invite by following the link in the email, provided the invite is still valid (i.e., it is not expired or previously been used).
    • Ignore the invite until it expires.
  4. Role assigned: When an invitee accepts, they are assigned the role specified in the invite.

Terminology

  • Collaborator: A Wix user with edit or manage access to a site owned by a separate Wix account. See Roles & Permissions: Overview and Roles & Permissions: Information for Site Collaborators. Also referred to as a contributor.
  • Policy: See Role below.
  • Role: A defined type of access that an identity should have on a specific site or account. Wix provides several predefined roles, such as co-owner, website manager, and website designer. Account owners and co-owners can also define their own custom roles.
Did this help?