MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Moengage Create Campaigns API

4 actions 4 updates phrasing extends openapi/moengage-create-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'].post
$.paths['/v5/campaigns/{campaign_id}/validate'].post
$.paths['/campaigns'].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 Create Campaigns API
  version: 1.0.0
extends: openapi/moengage-create-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'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Push or Email campaign draft (V5)
      effect: write
      questions:
      - How do I start a campaign as a draft with the V5 API and fill it in later?
      - Can I save a Push or Email campaign without its audience and add it afterwards?
      instructions:
      - text: Create a new V5 email campaign draft.
      - text: Start a V5 push campaign draft 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['/v5/campaigns/{campaign_id}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a draft campaign is ready to publish
      effect: read
      questions:
      - How do I check whether a draft campaign would pass publish validation without changing it?
      - What blocking errors would stop my saved draft from going live?
      instructions:
      - text: Validate draft campaign {campaign_id} before I publish it.
        slots:
          campaign_id: path.campaign_id
      - text: Tell me what's blocking campaign {campaign_id} from publishing.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and launch a campaign (legacy)
      effect: write
      questions:
      - How do I create a complete Push or Email campaign in one call with the older campaigns endpoint?
      - Can I set content, audience and delivery all at once when creating a campaign?
      instructions:
      - text: Create a full email campaign with content, audience and schedule using the legacy endpoint.
      - text: Create a push campaign in workspace {MOE-APPKEY} in one request on the non-V5 campaigns API.
        slots:
          MOE-APPKEY: header.MOE-APPKEY
      method: generated
      generated: '2026-10-01'