Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Automation API

4 actions 4 updates phrasing extends openapi/mapp-automation-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mapp Marketing Cloud's API. It is a proposal applied on top of the contract, not a document Mapp Marketing Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/automation/find'].post
$.paths['/automation/getDetails'].post
$.paths['/automation/runOnce'].get

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 Mapp Engage public Automation API
  version: 1.0.0
extends: openapi/mapp-automation-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/automation/find'].post
  update:
    x-apievangelist-phrasing:
      intent: Search automations
      effect: read
      questions:
      - Which time-based and event-based automations do we have?
      - Can I look up several automations at once?
      instructions:
      - text: Find our event-based automations.
      - text: List the time-based automations and their status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/automation/getDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an automation's details
      effect: read
      questions:
      - What are the full settings of a specific automation?
      - Do I need to say whether an automation is time-based or event-based to see its details?
      instructions:
      - text: Get details for {automationType} automation {automationId}.
        slots:
          automationType: query.automationType
          automationId: query.automationId
      - text: Show the configuration of automation {automationId} of type {automationType}.
        slots:
          automationId: query.automationId
          automationType: query.automationType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/automation/runOnce'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a time-based automation now
      effect: write
      questions:
      - Can I trigger a scheduled automation immediately without changing its schedule?
      - Does running an automation once affect its status?
      instructions:
      - text: Run time-based automation {automationId} once right now.
        slots:
          automationId: query.automationId
      - text: Execute automation {automationId} immediately.
        slots:
          automationId: query.automationId
      method: generated
      generated: '2026-09-26'