Generated by API Evangelist
Written by API Evangelist tooling for MoEngage's API. It is a proposal applied on top of the contract, not a document MoEngage publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for MoEngage On-Site Messaging (OSM) Template OSM Templates API
version: 1.0.0
extends: openapi/moengage-osm-templates-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/custom-templates/osm'].put
update:
x-apievangelist-phrasing:
intent: Update an on-site messaging template
effect: write
questions:
- How do I edit an on-site messaging (OSM) template I already uploaded?
- Can active campaigns switch to my updated OSM template version?
instructions:
- text: Update OSM template {external_template_id} with details {basic_details}.
slots:
external_template_id: requestBody.external_template_id
basic_details: requestBody.basic_details
- text: Edit OSM template {external_template_id} and apply it to campaigns using it ({update_campaigns}).
slots:
external_template_id: requestBody.external_template_id
update_campaigns: requestBody.update_campaigns
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-templates/osm'].post
update:
x-apievangelist-phrasing:
intent: Create an on-site messaging template
effect: write
questions:
- How do I upload an on-site messaging template built outside MoEngage?
- Can I create a new OSM template for website campaigns through the API?
instructions:
- text: Create a new OSM template from {basic_details} with meta info {meta_info}.
slots:
basic_details: requestBody.basic_details
meta_info: requestBody.meta_info
- text: Upload my externally designed on-site message template {basic_details}.
slots:
basic_details: requestBody.basic_details
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-templates/osm/search'].post
update:
x-apievangelist-phrasing:
intent: Search on-site messaging templates
effect: read
questions:
- Which OSM templates are in my account?
- Can I search on-site messaging templates by who last updated them?
instructions:
- text: Find OSM templates named {template_name}, page {page}, {entries} per page.
slots:
template_name: requestBody.template_name
page: requestBody.page
entries: requestBody.entries
- text: Look up OSM template {template_id} (page {page}, {entries} entries).
slots:
template_id: requestBody.template_id
page: requestBody.page
entries: requestBody.entries
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.