MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Message Archival API

2 actions 2 updates phrasing extends openapi/moengage-message-archival-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 2

$.info

$.paths['/archival/view'].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 MoEngage Message Archival API
  version: 1.0.0
extends: openapi/moengage-message-archival-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: 1
- target: $.paths['/archival/view'].post
  update:
    x-apievangelist-phrasing:
      intent: View a message sent to a customer
      effect: read
      questions:
      - How do I look up the exact message a customer was sent by a campaign?
      - Can I retrieve an archived email for compliance using the campaign and send time?
      instructions:
      - text: Show archived {campaign_channel} msg of {campaign_id} to {user_id} at {sent_epoch_time}, {platform}, {event_name}, {delivery_type} {campaign_type}.
        slots:
          campaign_channel: requestBody.campaign_channel
          campaign_id: requestBody.campaign_id
          user_id: requestBody.user_id
          sent_epoch_time: requestBody.sent_epoch_time
          platform: requestBody.platform
          event_name: requestBody.event_name
          delivery_type: requestBody.delivery_type
          campaign_type: requestBody.campaign_type
      - text: Retrieve what user {user_id} received from campaign {campaign_id}.
        slots:
          user_id: requestBody.user_id
          campaign_id: requestBody.campaign_id
      method: generated
      generated: '2026-10-01'