POST

Bulk Upsert Email Subscription


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates or creates multiple email subscriptions.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Email Subscriptions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/email-subscriptions/bulk

Body Params
subscriptionsArray <EmailSubscription>RequiredminItems 1maxItems 100

List of email subscriptions to update or create.

Response Object
resultsArray <BulkUpsertEmailSubscriptionResult>

List of updated or created email subscriptions.


metadataMetadata

Numbers of successful and failed actions.

Update or Create Multiple Subscriptions
Request
cURL
curl -X POST \ 'https://www.wixapis.com/email-marketing/v1/email-subscriptions/bulk' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "subscriptions": [ { "email": "lead-1@new-contact.com", "subscriptionStatus": "PENDING", "deliverabilityStatus": "VALID" }, { "email": "lead-2@existing-contact.com", "subscriptionStatus": "UNSUBSCRIBED", }, { "email": "lead-3@new-contact-default-statuses.org" } ] }'
Response
JSON
{ "subscriptions": [ { "id": "9c130f52-31c4-11ed-a261-0242ac120002", "email": "lead-1@new-contact.com", "subscriptionStatus": "PENDING", "deliverabilityStatus": "VALID", "createdDate": "2019-10-30T17:22:10.299Z", "updatedDate": "2019-11-13T20:14:49.458Z" }, { "id": "e50c4534-d0a5-11ea-87d0-0242ac130003", "email": "lead-2@existing-contact.com", "subscriptionStatus": "UNSUBSCRIBED", "deliverabilityStatus": "NOT_SET", "createdDate": "2019-09-20T17:48:10.299Z", "updatedDate": "2019-11-13T20:14:49.458Z" }, { "id": "d009f926-3273-11eb-adc1-0242ac120002", "email": "lead-3@new-contact-default-statuses.org", "subscriptionStatus": "NOT_SET", "deliverabilityStatus": "NOT_SET", "createdDate": "2019-11-13T20:14:49.458Z", "updatedDate": "2019-11-13T20:14:49.458Z" } ] }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?