The Wix Account Invites API enables you to invite individuals to join your Wix account as team members, so you can expand your team and delegate account responsibilities efficiently. With this API, you can send email invitations, granting new team members specific roles and access privileges within your account. Learn more about Roles & Permissions.
The account invite lifecycle outlines the stages involved in sending, managing, and accepting invitations for individuals to become team members in a Wix account.
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 has multiple employees, you can invite them to join your Wix account, whether or not they already have a Wix account.
Call Create Invite with the employees email addresses, the roles to assign (referred to here as policies), and any specific assets they should not have access to (referred to here as resources). If no assets are specified, the employee will be given access to all assets in the account.
When the employee accepts the invitation, their user ID is created (if relevant) and assigned as a team member of your account.
This service manages all invites related actions (site and account level)
Invite ID.
Account ID.
Email address where the invite was sent.
Deprecated. Use policyIds
.
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.
Role IDs included in the invite.
Date the invite was last updated.
Assets the users are invited to join.
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 invite emails to a list of potential team members, inviting them to become team members of the requesting account. The invites may be limited to a specific resource (site or other asset). Maximum 50 invitees can be specified per call.
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.
Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept 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/account-invite/create' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"subjectsAssignments": [
{
"assignments": [
{
"policyId": "6600344420111308827",
"assignments": []
}
],
"subjectEmail": "some@email.com"
}
],
}'
{
"successfulInvites": [
{
"id": "bfb00082-28bd-4da9-b234-9c60e6b821ed",
"accountId": "<ACCOUNT-ID-FROM-AUTH-HEADER>",
"email": "some@email.com",
"inviterId": "fed9597b-0015-4cc2-b531-aff2ec248e7a",
"acceptLink": "https://manage.wix.com/team/accept?....",
"inviterAccountId": "fed9597b-0015-4de2-f530-aff2ec248e7a",
"dateCreated": "2024-11-11T12:15:18Z",
"dateUpdated": "2024-11-11T12:15:18Z",
"assignments": [
{
"policyId": "6600344420111308827"
}
],
"expirationDate": "2024-12-11T12:15:18Z"
}
]
}