SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO ALLOWED SENDERS API

5 actions 5 updates phrasing extends openapi/smtp2go-allowed-senders-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_senders/add'].post
$.paths['/allowed_senders/remove'].post
$.paths['/allowed_senders/update'].post
$.paths['/allowed_senders/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 SENDERS API
  version: 1.0.0
extends: openapi/smtp2go-allowed-senders-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_senders/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add addresses to the allowed senders list
      effect: write
      questions:
      - How do I add a sender domain to my allowed or restricted senders list?
      - Can I add multiple sender addresses to the senders list in one call?
      instructions:
      - text: Add {allowed_senders} to my Allowed Senders List.
        slots:
          allowed_senders: requestBody.allowed_senders
      - text: Append {allowed_senders} to the senders list for subaccount {subaccount_id}.
        slots:
          allowed_senders: requestBody.allowed_senders
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_senders/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove addresses from the allowed senders list
      effect: destructive
      questions:
      - How can I take a sender address off my allowed senders list?
      - Is it an error to remove a sender that isn't on the restricted senders list?
      instructions:
      - text: Remove {allowed_senders} from my Allowed Senders List.
        slots:
          allowed_senders: requestBody.allowed_senders
      - text: Drop {allowed_senders} from subaccount {subaccount_id}'s senders list.
        slots:
          allowed_senders: requestBody.allowed_senders
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_senders/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace the senders list and its mode
      effect: write
      questions:
      - Can I switch my senders list between whitelist, blacklist and disabled mode?
      - How do I overwrite the entire allowed senders list?
      instructions:
      - text: Replace my senders list with {allowed_senders} in {mode} mode.
        slots:
          allowed_senders: requestBody.allowed_senders
          mode: requestBody.mode
      - text: Set subaccount {subaccount_id}'s senders list to {allowed_senders} using mode {mode}.
        slots:
          subaccount_id: requestBody.subaccount_id
          allowed_senders: requestBody.allowed_senders
          mode: requestBody.mode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_senders/view'].post
  update:
    x-apievangelist-phrasing:
      intent: View the allowed senders list and mode
      effect: read
      questions:
      - Which senders are on my allowed senders list and what mode is it in?
      - Is my restrict senders setting currently whitelist or blacklist?
      instructions:
      - text: Show my Allowed Senders List and its restrict mode.
      - text: Show the senders list for subaccount {subaccount_id}.
        slots:
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'