SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO ALLOWED RECIPIENTS API

5 actions 5 updates phrasing extends openapi/smtp2go-allowed-recipients-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 5

$.info
$.paths['/allowed_recipients/add'].post
$.paths['/allowed_recipients/remove'].post
$.paths['/allowed_recipients/update'].post
$.paths['/allowed_recipients/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 ALLOWED RECIPIENTS API
  version: 1.0.0
extends: openapi/smtp2go-allowed-recipients-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: 4
- target: $.paths['/allowed_recipients/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add addresses to the Allowed Recipients List
      effect: write
      questions:
      - How do I add a domain to my allowed recipients list?
      - Can I append several email addresses to the recipients allow list at once?
      instructions:
      - text: Add {allowed_recipients} to my Allowed Recipients List.
        slots:
          allowed_recipients: requestBody.allowed_recipients
      - text: Append {allowed_recipients} to the allowed recipients for subaccount {subaccount_id}.
        slots:
          allowed_recipients: requestBody.allowed_recipients
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_recipients/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove addresses from the Allowed Recipients List
      effect: destructive
      questions:
      - How can I take a domain off my allowed recipients list?
      - What happens if an address I remove from allowed recipients isn't on the list?
      instructions:
      - text: Remove {allowed_recipients} from my Allowed Recipients List.
        slots:
          allowed_recipients: requestBody.allowed_recipients
      - text: Drop {allowed_recipients} from subaccount {subaccount_id}'s allowed recipients.
        slots:
          allowed_recipients: requestBody.allowed_recipients
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_recipients/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace the Allowed Recipients List
      effect: write
      questions:
      - Can I overwrite my whole allowed recipients list with a new set of addresses?
      - How do I turn the allowed recipients restriction on or off while replacing the list?
      instructions:
      - text: Replace my Allowed Recipients List with {allowed_recipients} and set enabled to {enabled}.
        slots:
          allowed_recipients: requestBody.allowed_recipients
          enabled: requestBody.enabled
      - text: Overwrite subaccount {subaccount_id}'s allowed recipients with {allowed_recipients}, enabled {enabled}.
        slots:
          subaccount_id: requestBody.subaccount_id
          allowed_recipients: requestBody.allowed_recipients
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_recipients/view'].post
  update:
    x-apievangelist-phrasing:
      intent: View the Allowed Recipients List
      effect: read
      questions:
      - Which addresses and domains are currently on my allowed recipients list?
      - Can I check a subaccount's allowed recipients?
      instructions:
      - text: Show my Allowed Recipients List.
      - text: Show the allowed recipients for subaccount {subaccount_id}.
        slots:
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'