MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Push Templates API

4 actions 4 updates phrasing extends openapi/moengage-templates-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/custom-templates/push'].put

$.paths['/custom-templates/push'].post

$.paths['/custom-templates/push/search'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Push Templates API
  version: 1.0.0
extends: openapi/moengage-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/push'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a push notification template
      effect: write
      questions:
      - How do I update a push template, creating a new version?
      - Can the new push template version flow into campaigns already using it?
      instructions:
      - text: Update push template {external_template_id} with meta info {meta_info}.
        slots:
          external_template_id: requestBody.external_template_id
          meta_info: requestBody.meta_info
      - text: Change the Android content of push template {external_template_id} to {ANDROID}, meta {meta_info}.
        slots:
          external_template_id: requestBody.external_template_id
          ANDROID: requestBody.ANDROID
          meta_info: requestBody.meta_info
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-templates/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push notification template
      effect: write
      questions:
      - How do I create a reusable push notification template for Android and iOS?
      - Can one push template cover both platforms?
      instructions:
      - text: Create a push template with meta info {meta_info}.
        slots:
          meta_info: requestBody.meta_info
      - text: Create an iOS push template with content {IOS} and meta {meta_info}.
        slots:
          IOS: requestBody.IOS
          meta_info: requestBody.meta_info
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-templates/push/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search push notification templates
      effect: read
      questions:
      - How do I find push templates by name or platform?
      - Which push templates use a particular style?
      instructions:
      - text: Search push templates named {template_name}, page {page}, {entries} per page.
        slots:
          template_name: requestBody.template_name
          page: requestBody.page
          entries: requestBody.entries
      - text: Find {platform} push templates, page {page} with {entries} entries.
        slots:
          platform: requestBody.platform
          page: requestBody.page
          entries: requestBody.entries
      method: generated
      generated: '2026-10-01'