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

locationIdsArray <string>Read-onlyformat GUIDmaxItems 20

Location ids included in the invite

callerCapabilitiesArray <string>maxItems 20maxLength 20

A set of capability keys representing the actions that the caller is allowed to perform on this specific contributor. This field is calculated based on the identity of the request sender and may differ between callers.

Did this help?