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.

App inbox messages

The App inbox functionality provides a platform-agnostic inbox for messages.
There is no default UI for the inbox, so a developer can integrate the inbox to fit your goals and branding.

Many Leanplum users make their inbox messages lead to a full-screen message when tapped, with a Back button that leads users back to the inbox.

The inbox can store up to 300 messages for extended periods of time, allowing users to return to messages after the initial send. These messages stay in the inbox until your users delete them, or you can manually delete or ‘force-expire’ messages by deleting them from the Leanplum dashboard.


App inbox messages don’t require push certificates, making them an effective way to reach users who have not subscribed for push notifications. Create an app inbox branch in your push campaigns so users who are not subscribed for push will still receive your message once they are inside your app.

Integrating app inbox

See the App Inbox developer docs for a full guide on how to integrate the inbox functionality in your app, as well as required SDK versions.

Once integrated, your developer can access the App Inbox data by calling the appropriate SDK method. Developers can set up the inbox to get messages, message counts, message attributes, and more.

Create an app inbox message

To create an app inbox message, create a new campaign, or add a new action to an existing campaign and select app inbox as the action type.




The title of your message


The text below your message title


Add an image to your app inbox message

Advanced options (Data)

Pass data with your message in the form of Text, Number, Bool, Group, File, or Color. (Dictionary)

Add Open Action

You have the option of adding an Open Action, which is an app function that's delivered to users immediately after they open your app inbox message. For example, you can deep link users to the app store to leave you a review.

An Open Action can be a:

  • Push registration message
  • URL deeplink
  • App rating request

On the Edit screen, click Add Open Action and select which app function you want as your Open Action. The Open Action becomes the next action in your campaign chain.

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

Deleting an inbox message

Your users can manage their own inboxes by reading and deleting your messages. You can also delete messages on behalf of your users — deleting an Inbox message from the campaign will delete it from users’ devices as well.


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

See Sub-Delivery for more.

Updated 9 months ago

App inbox messages

Suggested Edits are limited on API Reference Pages

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