Email subscription

8.2 Batch allows you to:

  • Add and remove email address from a user profile. The profile will automatically be created if needed.
  • Edit a profile's marketing subscription.

In order to set an email address and subscription status on a profile, the creation of a project is required. If no project is set up, any calls made for these actions will be ignored.

Here is how to set an email with a marketing subscription:

import { BatchUser } from '';

// This requires to have a custom user ID registered 
// or to call the `setIdentifier` method on the editor instance beforehand.
    .setEmail("")  // Null to erase. Addresses must be valid.
    .setEmailMarketingSubscriptionState(BatchEmailSubscriptionState.SUBSCRIBED) // or BatchEmailSubscriptionState.UNSUBSCRIBED