Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Process API

4 actions 4 updates phrasing extends openapi/mapp-process-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['/process/applyAction'].post
$.paths['/process/getDetails'].get
$.paths['/process/getProcessList'].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 Process API
  version: 1.0.0
extends: openapi/mapp-process-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['/process/applyAction'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the status of a process
      effect: write
      questions:
      - Can I pause or resume a running process?
      - Which call changes an existing process's status?
      instructions:
      - text: Apply a pause action to process {processId}.
        slots:
          processId: query.processId
      - text: Change the status of process {processId}.
        slots:
          processId: query.processId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/process/getDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a process
      effect: read
      questions:
      - What's the current state of a particular process?
      - Can I look up one process by its ID?
      instructions:
      - text: Get details for process {processId}.
        slots:
          processId: query.processId
      - text: Show what process {processId} is doing.
        slots:
          processId: query.processId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/process/getProcessList'].get
  update:
    x-apievangelist-phrasing:
      intent: List processes
      effect: read
      questions:
      - Which processes have failed recently?
      - How many processes can I list per page?
      instructions:
      - text: List processes with status {status}.
        slots:
          status: query.status
      - text: Show {limit} processes starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'