Email subscription

Since v4 of the Batch Web SDK, you can:

  • 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:

  • Javascript (ES8)
  • Javascript
batchSDK(async api => {
    const profile = await api.profile();
    // This requires to have a custom user ID registered 
    await profile.identify({customId: "custom_user_id"});
    await profile.edit(editor => {
        .setEmailAddress("") // Null to erase. Addresses must be valid.
        .setEmailMarketingSubscription("subscribed") // Or "unsubscribed"