latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

In-app

Get a user's in-app messages

Get a user's in-app messages. This endpoint always returns the user's non-selective (not app-specific) in-app messages; to also fetch app-specific in-app messages, include a <code>packageName</code> and <code>platform</code> in the request. This endpoint returns new messages and messages that have already been saved to a mobile inbox, and each message has a <code>read</code> field to indicate whether or not it has already been seen.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

get/api/inApp/getMessages

Query parameters

emailstring

The email address of the user for which to fetch in-app messages. Specify either an email or a userId.

userIdstring

The userId of the user for which to fetch in-app messages. Specify either an email or a userId.

countinteger required

The number of in-app messages to fetch.

platform'iOS' | 'Android' | 'Web' | 'OTT'

The platform of the app for which to retrieve selective in-app messages: iOS, Android, Web, or OTT (case-sensitive).

SDKVersionstring

Iterable SDK version (e.g., 6.2.17)

packageNamestring

The package name of the app for which to retrieve selective in-app messages.

Response

successful operation