SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO SUBACCOUNTS API

6 actions 6 updates phrasing extends openapi/smtp2go-subaccounts-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 6

$.info
$.paths['/subaccount/add'].post
$.paths['/subaccount/close'].post
$.paths['/subaccount/edit'].post
$.paths['/subaccount/reopen'].post
$.paths['/subaccounts/search'].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 SUBACCOUNTS API
  version: 1.0.0
extends: openapi/smtp2go-subaccounts-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: 5
- target: $.paths['/subaccount/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subaccount
      effect: write
      questions:
      - How do I create a subaccount for a client under my master account?
      - Can I give a new subaccount its own email limit and SMS allowance?
      - Is there a limit on how many subaccounts I can create per hour?
      instructions:
      - text: Create a subaccount named {fullname}.
        slots:
          fullname: requestBody.fullname
      - text: Create subaccount {fullname} for {subaccount_email} with a limit of {limit}.
        slots:
          fullname: requestBody.fullname
          subaccount_email: requestBody.subaccount_email
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subaccount/close'].post
  update:
    x-apievangelist-phrasing:
      intent: Close a subaccount
      effect: destructive
      questions:
      - How do I shut down a client's subaccount?
      - Can I deactivate an active subaccount?
      instructions:
      - text: Close subaccount {id}.
        slots:
          id: requestBody.id
      - text: Set subaccount {id} to Closed.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subaccount/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a subaccount's details
      effect: write
      questions:
      - How do I raise the sending limit on a subaccount?
      - Can I turn on archiving or 2FA enforcement for an existing subaccount?
      instructions:
      - text: Change subaccount {id}'s monthly limit to {limit}.
        slots:
          id: requestBody.id
          limit: requestBody.limit
      - text: Rename subaccount {id} to {fullname}.
        slots:
          id: requestBody.id
          fullname: requestBody.fullname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subaccount/reopen'].post
  update:
    x-apievangelist-phrasing:
      intent: Reopen a closed subaccount
      effect: write
      questions:
      - Can I reactivate a subaccount I closed earlier?
      - How do I bring a closed subaccount back to active?
      instructions:
      - text: Reopen subaccount {id}.
        slots:
          id: requestBody.id
      - text: Reactivate closed subaccount {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subaccounts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search subaccounts
      effect: read
      questions:
      - Which subaccounts do I have, and which are closed?
      - Can I search my subaccounts by name?
      instructions:
      - text: List my subaccounts.
      - text: Find subaccounts matching {search_terms}.
        slots:
          search_terms: requestBody.search_terms
      - text: Show subaccounts in states {states}.
        slots:
          states: requestBody.states
      method: generated
      generated: '2026-10-01'