# 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 Suppression API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-suppression-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: 8
- target: $.paths['/api/suppression'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressed email addresses
      effect: read
      questions:
      - Which email addresses are on my do-not-send suppression list?
      - Can I filter suppressed emails by the reason they were suppressed?
      instructions:
      - text: List suppressed emails with reason {reason}.
        slots:
          reason: query.reason
      - text: Search the email suppression list for {search}, page {page} of {limit}.
        slots:
          search: query.search
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress a single email address
      effect: write
      questions:
      - How do I stop all sending to one specific email address?
      - Can I add an individual person to the suppression list?
      instructions:
      - text: Add an email address to the suppression list.
      - text: Suppress one recipient so we never email them.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-add emails to the suppression list
      effect: write
      questions:
      - Can I upload many email addresses to the suppression list in one request?
      - Is there a bulk way to suppress a batch of unsubscribes?
      instructions:
      - text: Bulk-add these email addresses to the suppression list.
      - text: Suppress a batch of emails at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check emails against the suppression list
      effect: read
      questions:
      - Before a send, can I check which of these emails are suppressed?
      - Which addresses in my batch are blocked from sending?
      instructions:
      - text: Check emails {emails} against the suppression list.
        slots:
          emails: requestBody.emails
      - text: Tell me which of {emails} are suppressed.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email from the suppression list
      effect: destructive
      questions:
      - Can I take an email address off the suppression list so they can be emailed again?
      - What if someone was suppressed by mistake?
      instructions:
      - text: Remove {email} from the suppression list.
        slots:
          email: path.email
      - text: Unsuppress email address {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressed domains
      effect: read
      questions:
      - Which whole domains are blocked from receiving my emails?
      - Can I search my suppressed domains by name?
      instructions:
      - text: Search suppressed domains for {search}.
        slots:
          search: query.search
      - text: List suppressed domains, page {page} with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress an entire domain
      effect: write
      questions:
      - Can I block sending to every address at a particular domain?
      - How do I add a company domain to the suppression list?
      instructions:
      - text: Add a domain to the suppression list.
      - text: Suppress every address at a domain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/suppression/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from the suppression list
      effect: destructive
      questions:
      - Can I unblock a domain I suppressed earlier?
      - What happens to sending once I remove a domain suppression?
      instructions:
      - text: Remove domain {domain} from the suppression list.
        slots:
          domain: path.domain
      - text: Unsuppress the domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'