Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Related Data API

5 actions 5 updates phrasing extends openapi/mapp-related-data-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 5

$.info
$.paths['/relatedData/createRecord'].post
$.paths['/relatedData/deleteRecords'].post
$.paths['/relatedData/getRecordsByKey'].get
$.paths['/relatedData/updateRecords'].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 Mapp Engage public Related Data API
  version: 1.0.0
extends: openapi/mapp-related-data-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: 4
- target: $.paths['/relatedData/createRecord'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a record to a related data set
      effect: write
      questions:
      - How do I add one row of data to a related data set for a contact?
      - What must a new related data record include?
      instructions:
      - text: Add a record to the products data set for key test-user@example.com.
      - text: Insert one new related data row with these column values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relatedData/deleteRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete related data records
      effect: destructive
      questions:
      - Can I delete only the related data rows that match a filter?
      - How do I remove a customer's records from a related data set?
      instructions:
      - text: Delete the products records for testuser@domain.com where bicycle is 14.
      - text: Remove all related data records under this key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relatedData/getRecordsByKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Get related data records for a key
      effect: read
      questions:
      - What related data rows are stored for a particular customer?
      - Can I read every record under one key in a data set?
      instructions:
      - text: Get all records in data set {datasetName} for key {key}.
        slots:
          datasetName: query.datasetName
          key: query.key
      - text: Show the {datasetName} rows stored for {key}.
        slots:
          datasetName: query.datasetName
          key: query.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relatedData/updateRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Update related data records for a key
      effect: write
      questions:
      - Does updating related data without a filter delete and re-add all rows for the key?
      - Can I change the unique column of a related data record?
      instructions:
      - text: Update the products records for this key with new values.
      - text: Replace all related data rows for this customer with these.
      method: generated
      generated: '2026-09-26'