MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Moengage Update Campaigns API

6 actions 6 updates phrasing extends openapi/moengage-update-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 6

$.info
$.paths['/v5/campaigns/{campaign_id}'].patch
$.paths['/v5/campaigns/{campaign_id}/status'].patch
$.paths['/campaigns/{campaign_id}'].patch
$.paths['/campaigns/status'].post
$.paths['/global-control-group/users'].put

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 Update Campaigns API
  version: 1.0.0
extends: openapi/moengage-update-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: 5
- target: $.paths['/v5/campaigns/{campaign_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a campaign draft (V5)
      effect: write
      questions:
      - How do I change the content or audience of a draft campaign with the V5 API?
      - Can I update just one component of a draft campaign?
      instructions:
      - text: Update draft campaign {campaign_id}'s content.
        slots:
          campaign_id: path.campaign_id
      - text: Change the audience on V5 draft {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/campaigns/{campaign_id}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause, resume or stop a published campaign (V5)
      effect: destructive
      questions:
      - How do I pause a published email campaign with the V5 API?
      - Which state transitions can I apply to a live V5 campaign?
      instructions:
      - text: Apply {action} to published campaign {campaign_id}.
        slots:
          action: requestBody.action
          campaign_id: path.campaign_id
      - text: Stop V5 campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{campaign_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API-created campaign (legacy)
      effect: write
      questions:
      - How do I update a campaign I created through the API on the legacy endpoint?
      - Can I edit dashboard-created campaigns via the older update endpoint?
      instructions:
      - text: Update legacy campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      - text: Edit the content of API-created campaign {campaign_id} on the older endpoint.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop, pause or resume several campaigns (legacy)
      effect: destructive
      questions:
      - Can I pause several API-created campaigns at once?
      - How do I resume campaigns in bulk on the legacy status endpoint?
      instructions:
      - text: Apply {action} to campaigns {campaign_ids}, request {request_id}.
        slots:
          action: requestBody.action
          campaign_ids: requestBody.campaign_ids
          request_id: requestBody.request_id
      - text: Resume legacy campaigns {campaign_ids} with action {action} and request {request_id}.
        slots:
          campaign_ids: requestBody.campaign_ids
          action: requestBody.action
          request_id: requestBody.request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/global-control-group/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or remove users in the Global Control Group
      effect: write
      questions:
      - How do I add users to the Global Control Group so they're held out of campaigns?
      - Can I remove a list of users from the global control group with a CSV?
      instructions:
      - text: '{action_type} the users in {file_url} to the Global Control Group, by {updated_by}, request {request_id}.'
        slots:
          action_type: requestBody.action_type
          file_url: requestBody.file_url
          updated_by: requestBody.updated_by
          request_id: requestBody.request_id
      - text: Remove users listed in {file_url} from the global control group as {updated_by}, action {action_type}, request {request_id}.
        slots:
          file_url: requestBody.file_url
          updated_by: requestBody.updated_by
          action_type: requestBody.action_type
          request_id: requestBody.request_id
      method: generated
      generated: '2026-10-01'