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.

Use cases

Site invite lifecycle

The site invite lifecycle outlines the stages involved in sending, managing, and accepting invitations for individuals to collaborate on a Wix site.

  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.
  • 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?

Sample Flows

This article shares some typical use cases you can support, as well as an example flow that supports each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your implementation.

Manage invitations sent to customers for the Wix site your company created for them

If your company creates Wix sites before handing them over to customers, you can invite the relevant customers to manage their sites once the site design and setup are complete.

  1. Select the relevant roles (referred to in Bulk Invite as policies) to apply to the invitees when they accept the invitation. See Roles and Permissions for a list of available roles.
  2. Call Bulk Invite with the relevant email addresses and roles to apply to their access. For example, co-owner or website manager. Each invitee is assigned an invite ID.
  3. If a customer misplaces the invitation email, you can call Resend Invite to trigger a new invite email to the specific invitee, passing the inviteId returned from the Bulk Invite call.
  4. If the customer's invitation to the site needs to be revoked for any reason before it is accepted, you can call Revoke Invite, passing the inviteId returned from the Bulk Invite call.
Did this help?

Site Invite Object


This service manages all invites related actions (site and account level)

Properties
idstringRead-onlyformat GUID

Invite ID.


siteIdstringRead-onlyformat GUID

Site ID the user is invited to as a collaborator.


emailstringformat EMAIL

Email address where the invite was sent.


policyIdsArray <string>

Role IDs included in the invite.


inviterIdstringRead-onlydeprecated

Deprecated. Use inviterAccountId.


statusstring

Invite Status.

Supported values:

  • Pending: The invite has been sent and is valid, waiting for the user's response.
  • Used: The invite has been accepted.
  • Deleted: The invite has been deleted or revoked.
  • Declined: The user declined the invite.
  • Expired: The invite has expired without being accepted.

acceptLinkstring

Link to accept the invite.


inviterAccountIdstringRead-onlyformat GUID

Inviting account ID.


acceptedByAccountIdstringRead-onlyformat GUID

Account ID that accepted the invite. Populated only once the invite is accepted.


dateCreatedstringformat date-time

Date the invite was created.


staffIdstringformat GUID

User's Wix Bookings staff ID, if relevant.


expirationDatestringformat date-time

Invite expiration date

Did this help?

POST

Bulk Invite


Developer Preview

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

Creates and sends emails inviting potential site contributors to become contributors in the requesting site.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Endpoint
POST
https://www.wixapis.com/invites/site-invite/bulk

Body Params
policyIdsArray <string>Required

Role IDs, referred to as policy IDs, to assign to the contributors.


emailsArray <string>RequiredminItems 1maxItems 10

Email addresses to which the invites should be sent.


invitePurposestring

Details explaining the purpose of the invite.


defaultEmailLanguagestring

Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language.

Response Object
invitesArray <SiteInvite>

Invites that were sent successfully.


failedEmailsArray <string>

Invites that failed.

Invite contributor to site
Request
cURL
curl -X POST \ 'https://www.wixapis.com/invites/site-invite/bulk' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "policyIds": [ "6600344420111308827" ], "emails": [ "some@email.com" ] }'
Response
JSON
{ "invites": [ { "id": "0092ff87-6028-41cb-92b5-980d5474abcf", "siteId": "<SITE-ID-FROM-AUTH-HEADER>", "email": "some@email.com", "policyIds": ["6600344420111308827"], "inviterId": "fed9597b-0015-4cc2-b531-aff2ec248e7a", "acceptLink": "https://manage.wix.com/contributors/accept?.....", "inviterAccountId": "fed9597b-3d9f-4cc2-b913-aff2ec249e7a", "dateCreated": "2024-11-11T12:09:59Z", "expirationDate": "2024-12-11T12:09:59Z" } ] }
Did this help?

POST

Resend Invite


Developer Preview

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

Resends the email invitation to a potential site contributor.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Endpoint
POST
https://www.wixapis.com/invites/site-invite/{inviteId}/resend

Path Params
inviteIdstringRequired

Invite ID.

Body Params
defaultEmailLanguagestring

Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language.

Response Object
inviteInvite

Invites that were sent.

Resend contributor invite
Request
cURL
curl -X POST \ 'https://www.wixapis.com/invites/site-invite/0092ff87-6028-41cb-92b5-980d5474abcf/resend' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "id": "0092ff87-6028-41cb-92b5-980d5474abcf", "siteId": "<SITE-ID-FROM-AUTH-HEADER>", "email": "some@email.com", "policyIds": ["6600344420111308827"], "inviterId": "fed9597b-0015-4cc2-b531-aff2ec248e7a", "acceptLink": "https://manage.wix.com/contributors/accept?.....", "inviterAccountId": "fed9597b-3d9f-4cc2-b913-aff2ec249e7a", "dateCreated": "2024-11-11T12:09:59Z", "expirationDate": "2024-12-11T12:09:59Z" }
Did this help?

POST

Revoke Invite


Developer Preview

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

Revokes a pending site contributor invite.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Endpoint
POST
https://www.wixapis.com/invites/site-invite/{inviteId}/revoke

Path Params
inviteIdstringRequired

Invite ID.

Response Object
Returns an empty object.
Revoke contributor invite
Request
cURL
curl -X POST \ 'https://www.wixapis.com/invites/site-invite/0092ff87-6028-41cb-92b5-980d5474abcf/revoke' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{}
Did this help?