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.

The Delivery tab is where you decide when a campaign should start and end. You can either set a scheduled start time, or use a trigger to bring users into your campaign based on user behavior.

After selecting your Goal and Audience, click Next to go to the Delivery tab and choose your campaign’s delivery settings.

Scheduled vs. Triggered Delivery

Delivery

Description

Scheduled

Scheduled delivery enters the targeted audience into the campaign on the day and time you select.

You can schedule a campaign to deliver one time only or add additional recurring rules.

Scheduled campaigns can be delivered:

Recurring Campaigns are useful for re-engagement use cases like sending coupon codes, notifying users of new items every week, offering discounts for anniversaries, weekly digests and others. Scheduled recurring delivery helps you automate your routine of sending campaigns and save time.

Triggered

Triggered delivery, enters a targeted user into the campaign only when that user completes a particular action — such as tapping a button or completing a purchase.

With triggered delivery, users must complete the selected trigger(s) in order to enter the campaign. This type of behavior-based delivery can be more effective at driving engagement than scheduled blasts.

Scheduled Delivery

To send campaigns on a specific date and time, select the Scheduled option in the Delivery tab.

Deliver Campaign options allow you to send the campaign:

Deliver Once (default)

To deliver a campaign one time only:

  1. Select Once in the Deliver Campaign dropdown (selected by default)
  2. Specify campaign Start
    1. Select the Immediately after publish radio button to start the campaign immediately after Start Campaign confirmation button is clicked
      or
    2. Select the On [Date] [Time] radio button to schedule campaign start on a specific date and time (selected by default)
      • Select a start date from the Date dropdown
      • Select a start time - Scheduled campaigns default to Optimal Time delivery, so you’ll need to choose another time zone setting in the Timezone dropdown before you can edit the start time
  3. Specify campaign End (optional)
    1. Check the End checkbox
    2. Select an end date and time from Date and Time dropdowns that appeared

📘

End Date

Once the end date passes, new users won't be able to enter the campaign, and users who are already in the campaign won't get any more messages.

If your campaign is a one-message blast, you can probably ignore the End Time setting, since your campaign will be over once the message goes out. But, if your campaign involves triggered in-app messages or variables, you may want to set an end date and time to prevent users from triggering messages that are no longer relevant (like after a sale is already over).

Repeat Daily

To create a daily recurring campaign:

  1. Select Daily in the Deliver Campaign dropdown
  2. Specify campaign Start
    1. Select a start date from the Date dropdown
    2. Select a start time - Scheduled campaigns default to Optimal Time delivery, so you’ll need to choose another time zone setting in the Timezone dropdown before you can edit the start time
  3. Set a Repeat pattern - Enter the interval (number of days) the campaign should repeat at, e.g. Repeat every [3] days
  4. Specify campaign End
    1. To stop campaign delivery at a specific day, select the On [Date] radio button
    2. To stop campaign delivery after X occurrences, select the After __ occurrences radio button

Repeat Weekly

To create a weekly recurring campaign:

  1. Select Weekly in the Deliver Campaign dropdown
  2. Specify campaign Start
    1. Select a start date from the Date dropdown
    2. Select a start time - Scheduled campaigns default to Optimal Time delivery, so you’ll need to choose another time zone setting in the Timezone dropdown before you can edit the start time
  3. Set a Repeat pattern
    1. Enter the interval (number of weeks) the campaign should repeat at, e.g. Repeat every [3] weeks
    2. Select on which days of the week to deliver the campaign. You can choose multiple days, e.g. Repeat every Monday and Wednesday
  4. Specify campaign End
    1. To stop campaign delivery at a specific day, select the On [Date] radio button
    2. To stop campaign delivery after X occurrences, select the After __ occurrences radio button

Repeat Monthly

To create a monthly recurring campaign:

  1. Select Monthly in the Deliver Campaign dropdown
  2. Specify campaign Start
    1. Select a start date from the Date dropdown
    2. Select a start time - Scheduled campaigns default to Optimal Time delivery, so you’ll need to choose another time zone setting in the Timezone dropdown before you can edit the start time
  3. Set a Repeat pattern
    1. Enter the interval (number of months) the campaign should repeat at, e.g. Repeat every [3] months
    2. Select on which days of the month to deliver the campaign:
      1. On day __ - enter the day of the month, e.g. Repeat on day [3] of the month
      2. On the [Week] [Day] - select the first, second, third, fourth or last week and day of the week, e.g. Repeat on the [Second] [Friday] of the month
      3. On __ day before month end - enter how many days before the end of the month, e.g. Repeat on [3] days before month end
  4. Specify campaign End
    1. To stop campaign delivery at a specific day, select the On [Date] radio button
    2. To stop campaign delivery after X occurrences, select the After __ occurrences radio button

🚧

Recurring campaigns with Optimal Time / Users timezone

Recurring campaigns with Optimal Time or Users timezone delivery are scheduled roughly 1 day in advance to accommodate for the different timezones.

Eligible users are selected at the time of schedule, so newly created users on the day of the delivery will not be included in the campaign for that day. They will receive the next occurrence of that campaign.

Optimal Time and Timezones

With Scheduled delivery method you can choose between four possible timing/timezone options:

Timezone option

Description

Optimal Time (default)

The campaign will start at a unique time for each user, based on the time of day the user is typically most active in your app. If the first action in your campaign is an email, Optimal Time is determined by that user's open and send rates with emails from your domain. See here for more on Optimal Time.

User’s Timezone

(Scheduled campaigns only.) The campaign will start at the time selected in the user’s timezone.

My time

The campaign will start at the time selected in your timezone. The name of your time zone will appear in parentheses (for instance: Pacific, Central, etc.).

UTC

Users will receive the first action at the time entered in Universal Time Coordinated.

🚧

Getting started with Optimal Time

Users who don't have previous session data (such as newly-imported users) may not receive Optimal Time campaigns, since Leanplum won't have enough data to calculate their Optimal Time.

To avoid message send failures:

  • Contact your CSM to set a default timezone for users with 0 sessions.
  • Schedule campaigns with UTC Time for the first month you use Leanplum.

Triggered Delivery

To send behavior-based campaigns:

  1. Select the Triggered option in the Delivery tab
  2. Specify campaign Start
    1. Select a start date from the Date dropdown
    2. Select a timezone from the Timezone dropdown
    3. Select a start time from the Time dropdown
  3. Specify campaign End (optional)
    1. Check the End checkbox
    2. Select an end date and time from Date and Time dropdowns that appeared
      Once the end date passes, new users won't be able to enter the campaign, and users who are already in the campaign won't get any more messages.
  4. Specify the event(s) that trigger(s) the delivery of the Campaign using the Choose Trigger dropdown
    There are several trigger event options to choose from in the dropdown.

Trigger Event Options

Event

Description

User first starts app

When a user opens the app and initializes Leanplum for the first time.

User starts app

When a user opens the app and initializes Leanplum.

User starts or resumes app

When a user opens the app or brings it up from the background.

User triggers event

When a user does a specific event. (Can be one of your custom events, or a Campaign's Enter or Exit event.)

Campaign enter

When a user enters another campaign.

Campaign exit

When a user completes or is exited from a different campaign.

User triggers event when parameter

When a user triggers an event with a parameter value that contains, is greater than, or is less than a certain value.
The parameter name must be an exact match - it is case sensitive. The parameter value is case insensitive - it will match both "My Value" and "my value".

User advances to state

When a user advances from to a particular state.

User attribute changes

When a user attribute changes to any value or to a particular value.

User enters region

When a user travels into a specific geographic area. (Use the Region Manager to define your regions.)

User exits region

When a user travels outside of a predefined geographic region.

Entry Limits

Limit how frequently a user can re-enter the same campaign. The limit timer begins when the user enters a campaign and receives the first action. Every user's entry counts towards the limit, even if the user later converts or exits out of the campaign.

Option

Description

Users can only enter the campaign up to __ time(s) ever.

This limits the number of times a user can receive the campaign. For example, we recommend users receive a re-engagement campaign "up to 3 times ever" to prevent spamming them with repeated content.

Users can only enter the campaign once every __ Minutes/Hours/Days.

This limits how frequently a user can receive a campaign. For example, a coupon or "special offer" campaign might benefit from a "30-day" limit. This will maximize your profits by preventing users from receiving too many promotions.

Quiet Hours

Check the Quiet Hours box to create a window of time when external messages and actions will not go out to users. External messages and other actions (like emails, push notifications, etc.) scheduled during quiet hours will be sent as soon as quiet hours are over.

📘

This setting will affect all actions in the campaign except In-app Messages and App Functions, users currently using the app will be able to trigger in-app actions any time. If they are currently using your app, late-night or early morning messages probably won’t disturb them. Note that App Inbox actions are effected by quiet hours.

Caps Exempt

Check the Caps Exempt box to ensure that all messages and actions in your campaign are delivered regardless of any daily or weekly message caps in your App Settings.

Preview Delivery Time

When you set your delivery method to Scheduled, the preview pane will show you an estimate of how long it should take for all of your users to receive the action.

This Delivery Estimate shows how many people in your target audience will enter the campaign. The preview is based on the quiet hours, users’ local time, and other delivery settings you chose, based on average user behavior and past campaigns.

The delivery preview shows the estimated number of targeted users entering the campaign over time in your time zone.

📘

How the Delivery Estimate is calculated

All delivery chart values are estimates based on a sample of 100,000 of your users. The sample is taken randomly, once a day, from all of your users from all time. For more on how the preview estimates are calculated, see Preview feedback calculation.

Actual vs Accumulated Values. Click the Actual Values toggle below the chart to view the accumulative number of users entering the campaign over time. This is the easiest way to determine when a certain percentage of targeted users (50%, 75%, etc.) will be entered into the campaign.

Accumulated preview

Updated about a month ago


Delivery


Suggested Edits are limited on API Reference Pages

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