Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Meta API

14 actions 14 updates phrasing extends openapi/mapp-meta-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 14

$.info
$.paths['/meta/activateAttributeDefinitions'].post
$.paths['/meta/archiveAttributeDefinitions'].post
$.paths['/meta/attachTags'].post
$.paths['/meta/createAttributeDefinitions'].post
$.paths['/meta/createLinkCategories'].post
$.paths['/meta/deleteLinkCategory'].post
$.paths['/meta/detachTags'].post
$.paths['/meta/findByTags'].post
$.paths['/meta/getAttributeDefinitions'].get
$.paths['/meta/getLinkCategories'].get
$.paths['/meta/getTags'].get
$.paths['/meta/mergeAttributeDefinitions'].post
$.paths['/meta/updateLinkCategory'].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 Meta API
  version: 1.0.0
extends: openapi/mapp-meta-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: 13
- target: $.paths['/meta/activateAttributeDefinitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate archived custom attributes
      effect: write
      questions:
      - How do I bring an archived custom attribute back so it shows in the personalization builder?
      - Can archived attributes be reactivated by name?
      instructions:
      - text: Reactivate the archived custom attribute named loyaltyTier.
      - text: Restore these archived attributes so they can be used in personalization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/archiveAttributeDefinitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive custom attributes
      effect: write
      questions:
      - Can I hide a custom attribute from message creation without deleting its data?
      - Do archived attributes still work in existing messages and sendouts?
      instructions:
      - text: Archive the custom attribute named legacyScore.
      - text: Archive these custom user attributes so editors stop using them.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/attachTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach tags to an entity
      effect: write
      questions:
      - How do I tag a message or other entity in Mapp Engage?
      - Can I add several tags to one entity at once?
      instructions:
      - text: Attach tags to {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      - text: Tag {entityType} {entityId} with spring-campaign.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/createAttributeDefinitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom user attributes
      effect: write
      questions:
      - How do I add a new custom data field to store information about users?
      - Is there a limit on how many custom attributes I can create?
      instructions:
      - text: Create a custom user attribute called favoriteStore of type string.
      - text: Define new custom attributes for storing profile data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/createLinkCategories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create link categories
      effect: write
      questions:
      - Can I group links for reporting by matching them with a regex pattern?
      - Which call sets up new link categories that can trigger automations on click?
      instructions:
      - text: Create a link category Promotions matching links containing /promo/.
      - text: Add new link categories with their regex patterns.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/deleteLinkCategory'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a link category
      effect: destructive
      questions:
      - How do I remove a link category I no longer need?
      - Can a link category be deleted once created?
      instructions:
      - text: Delete the Promotions link category.
      - text: Remove this link category from the system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/detachTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an entity
      effect: write
      questions:
      - Can I take specific tags off an entity without touching the others?
      - Which call untags a message?
      instructions:
      - text: Detach tags {tags} from {entityType} {entityId}.
        slots:
          tags: query.tags
          entityType: query.entityType
          entityId: query.entityId
      - text: Remove the spring-campaign tag from {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/findByTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Find entities by tag
      effect: read
      questions:
      - Which entities carry a given tag?
      - Can I filter tagged items by entity type?
      instructions:
      - text: Find all {entityType} entities tagged {tags}.
        slots:
          entityType: query.entityType
          tags: query.tags
      - text: Search for anything tagged {tags}.
        slots:
          tags: query.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/getAttributeDefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List active custom user attributes
      effect: read
      questions:
      - What custom attributes are currently active for users?
      - Does the attribute definition list include archived or system attributes?
      instructions:
      - text: List all active custom user attributes.
      - text: Show me the custom attribute definitions in use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/getLinkCategories'].get
  update:
    x-apievangelist-phrasing:
      intent: List link categories
      effect: read
      questions:
      - What link categories are set up for click reporting?
      - Can I see the patterns behind each link category?
      instructions:
      - text: List all link categories.
      - text: Show the link categories and their patterns.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/getTags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags on an entity
      effect: read
      questions:
      - What tags are attached to a particular message?
      - Where can I see every tag on an entity?
      instructions:
      - text: Get the tags on {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      - text: Show which tags entity {entityId} has.
        slots:
          entityId: query.entityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/mergeAttributeDefinitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync the full custom attribute list
      effect: write
      questions:
      - Can I archive, activate and create custom attributes in one full-list update?
      - What happens to custom attributes I leave out of a merge?
      instructions:
      - text: Merge this complete custom attribute list, deactivating any attribute not included.
      - text: Sync all custom attribute definitions to match my list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/meta/updateLinkCategory'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a link category
      effect: write
      questions:
      - Can I change the name or regex pattern of an existing link category?
      - Which call edits a link category after it's created?
      instructions:
      - text: Update the Promotions link category to match /offers/ instead.
      - text: Change the pattern on this existing link category.
      method: generated
      generated: '2026-09-26'