# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Suppression API
  version: 1.0.0
extends: openapi/adobe-suite-suppression-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['/config/suppression/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressed or allowed email addresses
      effect: read
      questions:
      - Which email addresses are on our suppression list?
      - Can I list only allowed addresses instead of suppressed ones, sorted and paged?
      instructions:
      - text: List suppressed email addresses in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {type} email addresses, {limit} at a time.
        slots:
          type: query.type
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email address to the suppression or allow list
      effect: write
      questions:
      - How do I stop messages going to a specific email address?
      - Can I add an address to the allowed list rather than the suppression list?
      instructions:
      - text: Add an email address to the suppression list in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Add an address to the {type} list.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/addresses/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one email address's suppression status
      effect: read
      questions:
      - Is a particular email address suppressed?
      - Can I check whether one address is on the allowed list?
      instructions:
      - text: Check whether {email} is suppressed.
        slots:
          email: path.email
      - text: Look up {email} on the {type} list.
        slots:
          email: path.email
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/addresses/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email address from suppression
      effect: destructive
      questions:
      - How do I unsuppress an email address so it can receive messages again?
      - Can I take one address off the allowed list?
      instructions:
      - text: Remove {email} from the suppression list.
        slots:
          email: path.email
      - text: Delete {email} from the {type} list.
        slots:
          email: path.email
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressed or allowed domains
      effect: read
      questions:
      - Which whole email domains are we suppressing?
      - Can I page through allowed domains ordered by a property?
      instructions:
      - text: List suppressed domains in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {type} domains ordered by {orderby}.
        slots:
          type: query.type
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to the suppression or allow list
      effect: write
      questions:
      - How do I block sending to an entire email domain?
      - Can I add a domain to the allowed list?
      instructions:
      - text: Add a domain to the suppression list in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Add a domain to the {type} list.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one domain's suppression status
      effect: read
      questions:
      - Is a specific email domain suppressed?
      - What does the suppression record for one domain show?
      instructions:
      - text: Check whether domain {domain} is suppressed.
        slots:
          domain: path.domain
      - text: Look up the suppression entry for {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from suppression
      effect: destructive
      questions:
      - How do I unblock a domain so mail can go to it again?
      - Can I delete a domain entry from the suppression list?
      instructions:
      - text: Remove domain {domain} from the suppression list.
        slots:
          domain: path.domain
      - text: Delete the suppression entry for {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/uploads'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppression upload jobs
      effect: read
      questions:
      - What bulk suppression uploads have been run?
      - Can I list CSV upload jobs sorted and paged?
      instructions:
      - text: List suppression upload jobs in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show the latest {limit} upload jobs ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk upload suppressions from a CSV
      effect: write
      questions:
      - Can I import a CSV of email addresses and domains to suppress?
      - How do I bulk add suppressions from a file?
      instructions:
      - text: Upload suppression CSV {file}.
        slots:
          file: requestBody.file
      - text: Import the suppressions in {file} into sandbox {sandbox}.
        slots:
          file: requestBody.file
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/uploads/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a suppression upload job
      effect: read
      questions:
      - Did my suppression CSV upload finish?
      - What is the status of a particular upload job?
      instructions:
      - text: Show upload job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check the status of suppression upload {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/uploads/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a suppression upload job record
      effect: destructive
      questions:
      - Can I delete an upload job record without removing the suppressions it created?
      - How do I clean up an old CSV upload job?
      instructions:
      - text: Delete upload job {jobId}.
        slots:
          jobId: path.jobId
      - text: Remove the record of suppression upload {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/suppression/admin/{imsOrgId}/{sandboxId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Wipe all suppressions in a sandbox
      effect: destructive
      questions:
      - How do I clear every suppression in a sandbox at once?
      - Is there a way to reset the entire suppression list for an org and sandbox?
      instructions:
      - text: Delete all suppressions for org {imsOrgId} in sandbox {sandboxId}.
        slots:
          imsOrgId: path.imsOrgId
          sandboxId: path.sandboxId
      - text: Wipe the suppression list in sandbox {sandboxId} of org {imsOrgId}.
        slots:
          sandboxId: path.sandboxId
          imsOrgId: path.imsOrgId
      method: generated
      generated: '2026-09-26'