Site Invite Object

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

Properties
acceptedByAccountIdstringRead-onlyformat GUID

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

acceptLinkstring

Link to accept 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.

dateCreatedstringformat date-time

Date the invite was created.

emailstringformat EMAIL

Email address where the invite was sent.

expirationDatestringformat date-time

Invite expiration date

idstringRead-onlyformat GUID

Invite ID.

inviterAccountIdstringRead-onlyformat GUID

Inviting account ID.

inviterIdstringRead-onlydeprecated

Deprecated. Use inviterAccountId.

locationIdsArray <string>Read-onlyformat GUIDmaxItems 20

Location ids included in the invite

policyIdsArray <string>

Role IDs included in the invite.

siteIdstringRead-onlyformat GUID

Site ID the user is invited to as a collaborator.

staffIdstringformat GUID

User's Wix Bookings staff ID, if relevant.

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.
Did this help?