API Reference

Send In-App Message

post
https://optimobile-push-service-api-{region}.optimove.net/v1/in-app-messages

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
target
object
required
int32
required
Defaults to 1
json
Defaults to {"tag":"content"}

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

string
enum
required
Defaults to next-open

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).

Allowed:
json
Defaults to {"key": "value"}

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

notification
object
schedule
object
inbox
object
json

Object keyed by customerID of meta-data for each recipient

json

Object of arbitrary meta-data about this notification

ttl
object
Responses

Updated 5 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago