v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

Send In-App Message

This endpoint can only be used with your Server credentials and allows you to send in-app messages directly to one or more customers.

post/v1/in-app-messages

Request body

templateIdinteger required
contentstring json

Object of dynamic content tags keyed by their respective title, required if template contains dynamic tags

presentedWhen'immediately' | 'next-open' | 'never' required

Immediately: If the message syncs during the users current session it will display immediately. Next Open: Once synced the message will be displayed at the start of the user's next session. Never: The message will not be shown unless the user explicitly opens it from the inbox or push notification (if configured).

datastring json

Optional object of additional key:values to be passed in the message payload for your app to consume

userMetastring json

Object keyed by customerID of meta-data for each recipient

reportingMetastring json

Object of arbitrary meta-data about this notification

Response

202