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.
Please note that using personalization attributes in messages sent via the OptiMobile API is not currently supported
Using Templates and Push Notifications with the In-App Message API
When using the In-App Message API, you can specify a
templateIdto utilize a predefined in-app message template. If you want to send a push notification (also known as a tickle) alongside the in-app message to notify the user, you have two options:
- Activate "Send Push Notification" in the In-App Message Editor:
- When creating your template, enable this option to define default tickle settings within the template.
- Include a
notificationObject in Your API Request:
- Add a notification object to your request to define the tickle's push notification details or to override the template's default tickle settings.
Key Points:
notificationObject: Represents the tickle's push notification. By including it in your API request, you can customize the tickle's title, message, and other notification details.- Fallback Behavior: If you do not provide a notification object but the template includes default tickle settings, the system will use those default settings.
- Personalization Tags: If your template contains personalization tags but no user attributes are provided in the API request, the personalization tags will fall back to default or empty values, depending on how the template was set up.