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.

In-App message basics

In-App messages can appear at different points in your app experience, usually immediately after a user triggers some sort of event or state. Leanplum has several in-app message templates to choose from, and you can customize your message's written content, colors, images, and more.

Create an in-app message action

To send an In-App Message, create a new campaign or add a new action to an existing one. After you set your campaign goal, audience, and delivery, choose In-App Message as the action type.



Top-level In-App Messages and Recurring campaigns

In-App Message as a first-level action is incompatible with the Recurring delivery method.

To create a valid campaign, either change the first-level action's channel or select a different delivery method.

Choose a template

Next, you’ll choose a template. Click a template to move to the editor and customize the content of your message. Below are the various in-app message templates you can choose from.

Confirm. Two-button message. Best for interactions that require a choice, like "Yes/No" or "Confirm/Cancel."

Center popup. Larger one-button message with more flexibility in design and message length than the alert message. Can include a background image, colored text, and supports different message sizes.

Alert. One-button message. Best for simple, informative messages.

Push pre-permission. iOS only. A single-purpose lead-in message. Clicking "OK" always displays the iOS system-level push permissions prompt. Clicking "Maybe Later" will save the permissions prompt for another time.

Interstitial. Full-screen message with flexible design and interactivity.

Web interstitial. Full-screen message from the web that is opened in a web view. Similar to Interstitial.

Floating interstitial. Interstitial message with HTML compatibility and two buttons.

Banner. Customizable banner at top of screen. Good for short messages that you don’t want to cover the center screen of your app.

Satisfaction survey. A survey to gather quick feedback from your users. You can present a single question at any time about a product they bought, a new feature they tried, or a video they just watched.

Edit your message content

After you choose your template, you can edit and customize the content of the message. As you fill in each field in the composer panel on the left, you can see an on-screen preview of your message on the right.


See Personalize a message for more on adding user's names and other custom values to your message.

Add a Cancel Action

If a user taps the dismiss button of the in-app message, you can still engage them by adding a Cancel Action. Adding a Cancel Action creates a new branch that automatically targets the user with a follow-up app function, such as linking them to the app store to leave a review.

On the Edit screen, click Add Cancel Action and select which app function you want as your Cancel Action.

A Cancel Action can be a:

  • Push registration message
  • URL deeplink
  • App rating request

By default, the Cancel Action will be delivered immediately, though you can add a delay if you want.

Choose a Sub-Delivery

Determines when your In-app message will send. This is where you set your Action delivery and Display when trigger.

See Sub-Delivery for more.

Personalize your message

You can also segment messages to send different versions to different audiences. See Personalize an action for details.

Updated 2 months ago

In-App message basics

Suggested Edits are limited on API Reference Pages

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