Go Headless

Build Apps

Client

API Preview

test

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# 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](fallback::https://support.wix.com/en/article/roles-permissions-information-for-site-collaborators).


## Use cases
- [Manage invitations sent to customers for the Wix site your company created for them](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f1174fe5-40eb-4a9a-bf82-5f5294e249e5slug::sample-flows#manage-invitations-sent-to-customers-for-the-wix-site-your-company-created-for-them*fallback::https://dev.wix.com/docs/rest/account-level/site-invites/sample-flows#manage-invitations-sent-to-customers-for-the-wix-site-your-company-created-for-them)
  
## 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](fallback::https://support.wix.com/en/article/roles-permissions-overview) and [Roles & Permissions: Information for Site Collaborators](fallback::https://support.wix.com/en/article/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.



# 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](fallback::https://support.wix.com/en/article/roles-permissions-overview) for a list of available roles.
1. Call [Bulk Invite](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f1174fe5-40eb-4a9a-bf82-5f5294e249e5slug::bulk-invite*fallback::https://dev.wix.com/docs/rest/account-level/site-invites/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.
1. If a customer misplaces the invitation email, you can call [Resend Invite](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f1174fe5-40eb-4a9a-bf82-5f5294e249e5slug::resend-invite*fallback::https://dev.wix.com/docs/rest/account-level/site-invites/resend-invite) to trigger a new invite email to the specific invitee, passing the `inviteId` returned from the Bulk Invite call. 
1. If the customer's invitation to the site needs to be revoked for any reason before it is accepted, you can call [Revoke Invite](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::f1174fe5-40eb-4a9a-bf82-5f5294e249e5slug::revoke-invite*fallback::https://dev.wix.com/docs/rest/account-level/site-invites/revoke-invite), passing the `inviteId` returned from the Bulk Invite call. 


inviteToken

AcceptSiteInviteRequest

AcceptSiteInviteResponse

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

defaultEmailLanguage

Email addresses to which the invites should be sent.

emails

Details explaining the purpose of the invite.

invitePurpose

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

policyIds

BulkSiteInviteRequest

failedEmails

invites

BulkSiteInviteResponse

contributorLimit

leftInvites

ContributorLimitation

GetContributorLimitRequest

GetContributorLimitResponse

GetSiteInviteRequest

GetSiteInviteResponse

GetSiteInvitesRequest

GetSiteInvitesResponse

Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc..

InviteStatus

ParseSiteInviteTokenRequest

inviteId

siteId

status

ParseSiteInviteTokenResponse

Supports only `filter` field with
`"filter" : {
"acceptedByAccountId":{"$in": [<id1>, <id2>, ...]}
}`

QuerySiteInvitesRequest

QuerySiteInvitesResponse

ResendSiteInviteRequest

RevokeSiteInviteRequest

RevokeSiteInviteResponse

acceptLink

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

acceptedByAccountId

dateCreated

email

expirationDate

inviterAccountId

inviterId

Site ID the user is invited to as a collaborator.

User's Wix Bookings staff ID, if relevant.

staffId

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.

SiteInvite

The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead

SiteInviteRequest

SiteInviteResponse

UpdateSiteInviteRequest

UpdateSiteInviteResponse

value

Int32Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Maximum number of items to return in the results.

limit

CursorPaging

Number of items to skip in the current sort order.

offset

Paging

Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.

Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.

fieldsets

Filter object.

Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).

filter

Sort object.

Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).

sort

QueryV2

Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.

Paging options to limit and skip the number of items.

pagingMethod

SortOrder

fieldName

order

Sorting

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

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.

Invite contributor to site

BulkInvite

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.

Resend contributor invite

ResendInvite

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.