Leanplum's user guides and developer documentation.

Leanplum Documentation

Leanplum's user guides, SDK setup, API docs, and more resources are here to help you get the most out of A/B testing, Campaigns, Messaging, and Analytics.

Setup: Email messaging

Before you can send your first email campaign, there are a few things you need to set up.

Enable email on your account

📘

Email is an add-on feature that must be activated before you can get started. Contact your CSM if you'd like to enable email.

After enabling email, your company will be provisioned one or more dedicated IP addresses based on an email questionnaire form provided by the Email Success Team. Leanplum will send you records for your domain name (DNS) configuration to authorize our ESP to send email on behalf of your sending domain. Don’t worry. Your customer success manager and the Email Success Team will work with you through this process, which typically takes several business days.

To check whether Email is enabled on your account:

  1. In the dashboard, select your name in the top right and click “App settings.”
  2. Click Keys & Settings for your app.
  3. Click Email.

Update the App Settings for Email

Leanplum sets defaults for you, but we encourage you to check them before getting started. You can also override the defaults in the Message Composer whenever you create or edit an email message.

Under App settings > Keys & Settings > Email, you should see the following:

  1. “From” address: the email address users will see as the sender. Defaults to “[email protected]
  2. “From” name: the name users will see as the sender. Defaults to blank.
  3. Email user attribute: the user attribute where you are storing the user’s email address. Defaults to ‘email’ (lowercase). Again, you must set this in your app’s code.
  4. Recipient name: the user attribute you are using to store the user’s name. Defaults to blank.

Verify Leanplum has your users' email addresses

You can check to see how many valid email addresses you have in Leanplum by:

  1. Going to the User Dashboard
  2. Click the Add Segment dropdown
  3. Select User Attribute
  4. Select the attribute for email

🚧

If no user attribute for email shows up, you'll need to modify your app's code to send Leanplum your users' email addresses as a user attribute. Your app must send email addresses as a user attribute, preferably titled "email" (lowercase), for the Email feature to work.

  1. Click the operator is and select contains from the operator dropdown
  2. Change the value to "@"
  3. Click Search

Updated 10 months ago



Setup: Email messaging


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.