MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Moengage Test Campaigns API

4 actions 4 updates phrasing extends openapi/moengage-test-campaigns-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['/v5/campaigns/test'].post
$.paths['/campaigns/test'].post
$.paths['/personalization/preview'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Moengage Test Campaigns API
  version: 1.0.0
extends: openapi/moengage-test-campaigns-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['/v5/campaigns/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of a campaign (V5)
      effect: write
      questions:
      - How do I send a V5 test message to a few users before publishing?
      - Can I send a test push to specific device identifiers with the V5 API?
      instructions:
      - text: Send a V5 test of this email campaign to my test users.
      - text: Send a V5 test push with request ID {X-MOE-Request-Id}.
        slots:
          X-MOE-Request-Id: header.X-MOE-Request-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of an API-created campaign (legacy)
      effect: write
      questions:
      - Can I send a test of a campaign on the legacy endpoint before launching it to everyone?
      - Why can't I test a dashboard-created campaign through the older test endpoint?
      instructions:
      - text: Send a legacy test of my API-created push campaign to test users.
      - text: Test this API-built email campaign in workspace {MOE-APPKEY} on the older endpoint before launch.
        slots:
          MOE-APPKEY: header.MOE-APPKEY
      method: generated
      generated: '2026-10-01'
- target: $.paths['/personalization/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview personalized content (legacy)
      effect: read
      questions:
      - How do I preview a personalized SMS before sending it?
      - Can I check my personalization logic resolves correctly using the older preview endpoint?
      instructions:
      - text: Preview {personalization_content} with details {personalization_details}, request {request_id}.
        slots:
          personalization_content: requestBody.personalization_content
          personalization_details: requestBody.personalization_details
          request_id: requestBody.request_id
      - text: Show legacy preview of {personalization_content} for user {user_details}, details {personalization_details}, request {request_id}.
        slots:
          personalization_content: requestBody.personalization_content
          user_details: requestBody.user_details
          personalization_details: requestBody.personalization_details
          request_id: requestBody.request_id
      method: generated
      generated: '2026-10-01'