# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Stop List API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-stop-list-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/api/stop-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List my stop list entries
      effect: read
      questions:
      - Which emails and domains are on my workspace's do-not-contact list?
      - Can I search my own stop list by type?
      instructions:
      - text: List my stop list entries of type {type}, page {page} with {limit} per page.
        slots:
          type: query.type
          page: query.page
          limit: query.limit
      - text: Search my stop list for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an entry to my stop list
      effect: write
      questions:
      - How do I stop emailing one particular address or domain?
      - Can I add a single do-not-contact entry for my workspace?
      instructions:
      - text: Add this address to my stop list.
      - text: Put one domain on my workspace do-not-contact list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my stop list statistics
      effect: read
      questions:
      - How many entries are on my own stop list?
      - What's the breakdown of my do-not-contact list by type?
      instructions:
      - text: Show statistics for my stop list.
      - text: Count the entries in my workspace stop list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-add entries to my stop list
      effect: write
      questions:
      - Can I upload many unsubscribed addresses to my stop list at once?
      - Is there a bulk way to block a whole batch of emails for my workspace?
      instructions:
      - text: Bulk-add these addresses to my stop list.
      - text: Block this whole batch of emails in my workspace stop list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an entry from my stop list
      effect: destructive
      questions:
      - Can I take someone off my do-not-contact list?
      - What if I added an address to my stop list by mistake?
      instructions:
      - text: Remove stop list entry {id}.
        slots:
          id: path.id
      - text: Unblock entry {id} from my workspace stop list.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check emails against the stop list
      effect: read
      questions:
      - Are any of these addresses blocked before I send a campaign?
      - Can I check a batch of emails against the stop list in one call?
      instructions:
      - text: Check {emails} against the stop list.
        slots:
          emails: requestBody.emails
      - text: Tell me which of {emails} are blocked from sending.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/global'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform-wide stop list entries
      effect: read
      questions:
      - As a super admin, which entries are on the global stop list for every tenant?
      - Can I search the platform-wide stop list?
      instructions:
      - text: List global stop list entries of type {type}, page {page}, {limit} per page.
        slots:
          type: query.type
          page: query.page
          limit: query.limit
      - text: Search the global stop list for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/global'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an entry to the global stop list
      effect: write
      questions:
      - How does a super admin block an address for all tenants?
      - Can one domain be added to the platform-wide stop list?
      instructions:
      - text: Add this address to the global stop list for every tenant.
      - text: Block one domain platform-wide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/global/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global stop list statistics
      effect: read
      questions:
      - How big is the platform-wide stop list?
      - What are the super-admin statistics for the global do-not-contact list?
      instructions:
      - text: Show global stop list statistics.
      - text: Count entries on the platform-wide stop list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/global/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-add entries to the global stop list
      effect: write
      questions:
      - Can a super admin block a large list of addresses across all tenants at once?
      - Is there a bulk import for the global stop list?
      instructions:
      - text: Bulk-add these entries to the global stop list.
      - text: Block this batch of domains for all tenants.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stop-lists/global/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an entry from the global stop list
      effect: destructive
      questions:
      - Can a super admin unblock an address on the platform-wide stop list?
      - What if a domain was added to the global stop list by mistake?
      instructions:
      - text: Remove global stop list entry {id}.
        slots:
          id: path.id
      - text: Unblock entry {id} for all tenants.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'