# 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 Blacklist API
  version: 1.0.0
extends: openapi/mapp-blacklist-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['/blacklist/createGroupEntries'].post
  update:
    x-apievangelist-phrasing:
      intent: Block addresses for one group
      effect: write
      questions:
      - How do I stop an email address or domain from receiving mail from one group?
      - Can I block a mobile number for a single group only?
      instructions:
      - text: Add test@test.com to the blacklist for group {groupId}.
        slots:
          groupId: query.groupId
      - text: Block this email domain in group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blacklist/createGroupEntriesHashed'].post
  update:
    x-apievangelist-phrasing:
      intent: Block hashed emails for one group
      effect: write
      questions:
      - Can I blacklist emails for a group using MD5 hashes instead of plain addresses?
      - How do I add hashed entries to a group blacklist?
      instructions:
      - text: Add these MD5-hashed emails to the blacklist for group {groupId} with hashed set to {hashed}.
        slots:
          groupId: query.groupId
          hashed: query.hashed
      - text: Block hashed address 6a4b6cb2045fd55f706eaebd6ab5d4f7 in group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blacklist/createSystemEntriesHashed'].post
  update:
    x-apievangelist-phrasing:
      intent: Block hashed entries system-wide
      effect: write
      questions:
      - Can I add MD5-hashed emails or app aliases to the system-wide blacklist?
      - What types can go on the system blacklist in hashed form?
      instructions:
      - text: Add these hashed emails to the system blacklist with hashed set to {hashed}.
        slots:
          hashed: query.hashed
      - text: Block hashed address 0dbfb46341bc3d195db23e4015b20847 across the whole system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blacklist/createSystemEntries'].post
  update:
    x-apievangelist-phrasing:
      intent: Block addresses system-wide
      effect: write
      questions:
      - How do I block an email, domain or phone number from every group at once?
      - Can I add a plain phone number to the Mapp Engage system blacklist?
      instructions:
      - text: Add test@test.com to the system blacklist.
      - text: Block phone number 336789012345 system-wide.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blacklist/deleteGroupEntries'].post
  update:
    x-apievangelist-phrasing:
      intent: Unblock addresses for one group
      effect: destructive
      questions:
      - How do I remove an email from a group's blacklist so they can get mail again?
      - Can I lift a group-level block on a domain?
      instructions:
      - text: Remove test@test.com from the blacklist for group {groupId}.
        slots:
          groupId: query.groupId
      - text: Unblock this domain in group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blacklist/deleteSystemEntries'].post
  update:
    x-apievangelist-phrasing:
      intent: Unblock addresses system-wide
      effect: destructive
      questions:
      - Can I take an address off the system-wide blacklist?
      - Which call deletes system blacklist entries for phone numbers?
      instructions:
      - text: Remove test@test.com from the system blacklist.
      - text: Lift the system-wide block on phone number 336789012345.
      method: generated
      generated: '2026-09-26'