Email subscription

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

  • Swift
  • Objective-C
// This requires to have a custom user ID registered 
// or to call the `setIdentifier` method on the editor instance beforehand.
let editor = BatchUser.editor()
try? editor.setEmail("") // Nil to erase. Addresses must be valid.
editor.setEmailMarketingSubscriptionState(.subscribed) // or .unsubscribed

If you call editor method before startWithAPIKey it will return nil. You should always call it after you started the SDK, and check nullity to be safe.