SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO SUPPRESSIONS API

4 actions 4 updates phrasing extends openapi/smtp2go-suppressions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SMTP2GO's API. It is a proposal applied on top of the contract, not a document SMTP2GO publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/suppression/add'].post
$.paths['/suppression/remove'].post
$.paths['/suppression/view'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO SUPPRESSIONS API
  version: 1.0.0
extends: openapi/smtp2go-suppressions-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: 3
- target: $.paths['/suppression/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress an email address or domain
      effect: write
      questions:
      - How do I stop all email going to a specific address?
      - Can I block an entire domain from receiving my emails?
      instructions:
      - text: Suppress {email_address}.
        slots:
          email_address: requestBody.email_address
      - text: Block {email_address} with the note {block_description}.
        slots:
          email_address: requestBody.email_address
          block_description: requestBody.block_description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suppression/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Lift a suppression
      effect: destructive
      questions:
      - How do I unblock an address that got suppressed after a bounce?
      - Can I remove only certain suppression reasons for an address?
      instructions:
      - text: Remove the {reasons} suppressions on {email_address}.
        slots:
          reasons: requestBody.reasons
          email_address: requestBody.email_address
      - text: Unsuppress {email_address} for reasons {reasons}.
        slots:
          email_address: requestBody.email_address
          reasons: requestBody.reasons
      method: generated
      generated: '2026-10-01'
- target: $.paths['/suppression/view'].post
  update:
    x-apievangelist-phrasing:
      intent: List suppressed addresses and domains
      effect: read
      questions:
      - Which email addresses are on my suppression list?
      - Can I filter suppressions by reason, like bounces or spam complaints?
      - Is a particular recipient currently suppressed?
      instructions:
      - text: List my suppressions.
      - text: Show suppressions with reason {reason}.
        slots:
          reason: requestBody.reason
      - text: Check whether {email_address} is suppressed.
        slots:
          email_address: requestBody.email_address
      method: generated
      generated: '2026-10-01'