latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

Embedded Messaging

Get a user's embedded messages

This endpoint returns embedded messages for which the specified user is eligible, grouped by <code>placementId</code>.<br/><br/>By default, it returns data for all placements that have messages for the user. To constrain the response to specific placements, provide one or more <code>placementIds</code> query parameters.<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/embedded-messaging/messages

Query parameters

emailstring

User identifier. Provide an email or a userId, but not both.

userIdstring

User identifier. Provide a userId or an email, but not both.

platformstring

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

sdkVersionstring

Iterable SDK version (e.g., 6.5.0).

packageNamestring

The package name of the app for which to retrieve embedded messages.

placementIdsobject[]

Placements to include in the response, even if they don't have embedded messages for the user. When no placementIds are specified, the response includes all embedded messages for which the user is eligible.

currentMessageIdsstring[]

IDs of embedded messages already retrieved by the device making the request. If the user is no longer eligible for a specified message, that message will be omitted from the API response. Otherwise, it will be present, but without an elements field.

Response

successful operation