POST

Bulk Invite


Developer Preview

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.

Endpoint
POST
https://www.wixapis.com/invites/site-invite/bulk

Body Params
policyIdsArray <string>Required

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


emailsArray <string>RequiredminItems 1maxItems 10

Email addresses to which the invites should be sent.


invitePurposestring

Details explaining the purpose of the invite.


defaultEmailLanguagestring

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

Response Object
invitesArray <SiteInvite>

Invites that were sent successfully.


failedEmailsArray <string>

Invites that failed.

Invite contributor to site
Request
cURL
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" ] }'
Response
JSON
{ "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" } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?