Skip to main content
Sends invitation emails to the provided email addresses. Up to 25 emails can be sent in a single request. Existing affiliates and pending invitations are automatically skipped, and only the invitations created are returned.
Required scope: affiliates.write. A key without it receives a 403 error. See Authentication.

Request Body

array
required
Array of email addresses (1-25 items, each a valid address of at most 255 characters). Addresses are lower-cased and duplicates are removed.Example: ["john@example.com", "jane@example.com"]

Response

Returns 201 Created.
string
Invitation sent successfully. for one invitation, or N invitations sent successfully. otherwise
array
Invitations created by this request. Skipped addresses (existing affiliates of your store and addresses with a pending invitation) are not listed: when every address is skipped, data is an empty array.
array
Always empty on success