# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Suppressions Spam Reports API
  version: 1.0.0
extends: openapi/sendgrid-spam-reports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v3/suppression/spam_reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List spam report suppressions
      effect: read
      questions:
      - Which recipients marked my emails as spam?
      - Can I filter spam reports to a date range?
      instructions:
      - text: List all spam reports.
      - text: Show spam reports between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Search spam reports for addresses matching {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/spam_reports'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several or all spam reports
      effect: destructive
      questions:
      - Can I clear every spam report suppression at once?
      - What happens to sending once a spam report is removed?
      instructions:
      - text: Delete spam reports for {emails}.
        slots:
          emails: requestBody.emails
      - text: Clear all spam reports with delete_all set to {delete_all}.
        slots:
          delete_all: requestBody.delete_all
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/spam_reports/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an address reported spam
      effect: read
      questions:
      - Did a particular email address report my messages as spam?
      - When was a specific spam report created?
      instructions:
      - text: Get the spam report for {email}.
        slots:
          email: path.email
      - text: Check whether {email} is suppressed for a spam complaint.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/suppression/spam_reports/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one address's spam report
      effect: destructive
      questions:
      - A customer asked to receive email again after flagging it, how do I unsuppress just them?
      - Can I lift the spam suppression on just one address?
      instructions:
      - text: Delete the spam report for {email}.
        slots:
          email: path.email
      - text: Unsuppress the single address {email} from spam reports.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-24'