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.

Rich in-app messages

Rich in-app messages are based in HTML5, which offers more customization options than some other in-app message templates. Some of the added features include:

  • Hero images
  • Support for video and animations
  • Option to close automatically
  • Inline HTML support in text fields
  • Two-state buttons


To create and use rich in-app messages, your app must use a recent version of our SDK: iOS: 2.0.0+ and/or Android: 2.2.0+.

See below for details on each type of Rich in-app message.

Star Rating

The Star Rating survey is a great way 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.

See Star rating message for more.


The Banner template is a full-width, typically thin message that can appear anywhere on the user's device. It allows user inputs to other areas of the screen (unlike the Star Rating and Rich Interstitial), and its background can even be set to transparent (for things like tooltips).

You can even add animated images as the background image for an animated banner.

See Banner message for more.

Rich Interstitial

The Rich Interstitial is a more powerful version of our Interstitial in-app message. It can support up to two buttons (each with their own open action setting), as well as a close x button in the top corner. This allows for a common user interaction: a "decline, accept, or close" message often seen with terms and conditions.

See Rich interstitial message for more.

Updated 4 months ago

Rich in-app messages

Suggested Edits are limited on API Reference Pages

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