Email subscription

The iOS Batch SDK 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 by calling the `identify` method beforehand.
BatchProfile.editor { editor in
  try? editor.setEmailAddress("john.doe@batch.com") // Nil to erase. Addresses must be valid.
  editor.setEmailMarketingSubscriptionState(.subscribed) // or .unsubscribed
   // If you prefer to use BatchProfile.editor() with local variable instead of usiong a closure,
   // remember to use editor.save() afterwards so that the changes are taken into account.
}

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.