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.
The site invite lifecycle outlines the stages involved in sending, managing, and accepting invitations for individuals to collaborate on a Wix site.
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.
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.
inviteId
returned from the Bulk Invite call.inviteId
returned from the Bulk Invite call.This service manages all invites related actions (site and account level)
Invite ID.
Site ID the user is invited to as a collaborator.
Email address where the invite was sent.
Role IDs included in the invite.
Deprecated. Use inviterAccountId
.
Invite Status.
Supported values:
Link to accept the invite.
Inviting account ID.
Account ID that accepted the invite. Populated only once the invite is accepted.
Date the invite was created.
User's Wix Bookings staff ID, if relevant.
Invite expiration date
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.
Role IDs, referred to as policy IDs, to assign to the contributors.
Email addresses to which the invites should be sent.
Details explaining the purpose of the invite.
Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language.
Invites that were sent successfully.
Invites that failed.
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"
]
}'
{
"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"
}
]
}
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.
Invite ID.
Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language.
Invites that were sent.
curl -X POST \
'https://www.wixapis.com/invites/site-invite/0092ff87-6028-41cb-92b5-980d5474abcf/resend' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"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"
}
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.
Invite ID.
curl -X POST \
'https://www.wixapis.com/invites/site-invite/0092ff87-6028-41cb-92b5-980d5474abcf/revoke' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{}