OSM Templates Overview

The MoEngage On-Site Messaging (OSM) Templates API allows you to manage your web and app-site messaging templates. You can use this API to upload custom HTML templates created outside the MoEngage ecosystem, making them available for your OSM campaigns. This API supports multiple template formats including Banners, Pop-ups, and Nudges. Note that templates created via this API are supported within the Custom HTML Editor in the MoEngage Dashboard and cannot be used with the Drag and Drop Editor.

Endpoints

The OSM Templates API is a collection of the following endpoints:

Create OSM Template: Creates a new OSM template with an HTML payload.
Update OSM Template: Updates an existing OSM template and handles campaign versioning.
Search OSM Templates: Retrieves templates based on filters like template type, source, or creator.

FAQs

Which OSM template types are supported?

The API currently supports the creation and management of BANNER, POP_UP, and NUDGE template types. All payloads must be in HTML format.

Can I use API-created templates in the Drag and Drop Editor?

No. Templates uploaded via the API are only compatible with the Custom HTML Editor in the MoEngage Dashboard.

How do I handle updates for live campaigns?

When updating a template, you can set the update_campaigns flag.

True: Automatically updates all running campaigns to the new template version.
False: Creates a new version without affecting existing campaigns.

Postman Collection

Test these endpoints quickly by importing our Postman collection: View in Postman

Getting Started

Endpoints

​Endpoints

​FAQs

​Postman Collection

Endpoints

FAQs

Postman Collection