Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Member Attributes API

7 actions 7 updates phrasing extends openapi/mapp-member-attributes-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 7

$.info
$.paths['/memberAttributes/create'].post
$.paths['/memberAttributes/delete'].delete
$.paths['/memberAttributes/get'].get
$.paths['/memberAttributes/list'].get
$.paths['/memberAttributes/update'].put
$.paths['/memberAttributes/validateName'].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 Member Attributes API
  version: 1.0.0
extends: openapi/mapp-member-attributes-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: 6
- target: $.paths['/memberAttributes/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a member attribute for a group
      effect: write
      questions:
      - How do I define a new group-specific attribute for members?
      - Can each group have its own custom member fields?
      instructions:
      - text: Create a member attribute called seatNumber in group {groupId}.
        slots:
          groupId: query.groupId
      - text: Add a new member attribute definition to group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberAttributes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a member attribute from a group
      effect: destructive
      questions:
      - How do I remove a member attribute definition from a group?
      - Can a group's member attribute be deleted by ID?
      instructions:
      - text: Delete member attribute {attributeId} from group {groupId}.
        slots:
          attributeId: query.attributeId
          groupId: query.groupId
      - text: Remove attribute {attributeId} from group {groupId}'s member fields.
        slots:
          attributeId: query.attributeId
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberAttributes/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one member attribute definition
      effect: read
      questions:
      - What are the settings of a single member attribute in a group?
      - Can I read one member attribute definition by its ID?
      instructions:
      - text: Get member attribute {attributeId} in group {groupId}.
        slots:
          attributeId: query.attributeId
          groupId: query.groupId
      - text: Show the definition of attribute {attributeId} for group {groupId}.
        slots:
          attributeId: query.attributeId
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberAttributes/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's member attributes
      effect: read
      questions:
      - Which member attributes are defined for a group?
      - Where can I see all the group-specific fields a group has?
      instructions:
      - text: List member attributes for group {groupId}.
        slots:
          groupId: query.groupId
      - text: Show all member attribute definitions in group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberAttributes/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member attribute definition
      effect: write
      questions:
      - Can I rename or change a member attribute definition in a group?
      - Which call edits an existing group member attribute?
      instructions:
      - text: Update this member attribute definition in group {groupId}.
        slots:
          groupId: query.groupId
      - text: Rename a member attribute in group {groupId} to seatRow.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberAttributes/validateName'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a member attribute name is free
      effect: read
      questions:
      - Is a member attribute name already taken in a group?
      - Can I test name uniqueness before creating a member attribute?
      instructions:
      - text: Check whether {name} is available as a member attribute name in group {groupId}.
        slots:
          name: query.name
          groupId: query.groupId
      - text: Validate member attribute name {name} for group {groupId}.
        slots:
          name: query.name
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'