SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO TEMPLATES API

6 actions 6 updates phrasing extends openapi/smtp2go-templates-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['/template/add'].post
$.paths['/template/delete'].post
$.paths['/template/edit'].post
$.paths['/template/search'].post
$.paths['/template/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 TEMPLATES API
  version: 1.0.0
extends: openapi/smtp2go-templates-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['/template/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I create a reusable email template with variables?
      - What fields are required to add a new template?
      instructions:
      - text: Create template {id} named {template_name} with subject {subject}, HTML {html_body} and text {text_body}.
        slots:
          id: requestBody.id
          template_name: requestBody.template_name
          subject: requestBody.subject
          html_body: requestBody.html_body
          text_body: requestBody.text_body
      - text: Add template {id} called {template_name}, subject {subject}, with variables {template_variables}, HTML {html_body}, text {text_body}.
        slots:
          id: requestBody.id
          template_name: requestBody.template_name
          subject: requestBody.subject
          template_variables: requestBody.template_variables
          html_body: requestBody.html_body
          text_body: requestBody.text_body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template
      effect: destructive
      questions:
      - How do I delete an email template I don't use anymore?
      - Can I remove a template by its ID?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: requestBody.id
      - text: Remove template {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an email template
      effect: write
      questions:
      - How do I change the subject line of an existing template?
      - Can I give an existing template a new ID?
      instructions:
      - text: Change template {id}'s subject to {subject}.
        slots:
          id: requestBody.id
          subject: requestBody.subject
      - text: Rename template {id} to the new ID {new_id}.
        slots:
          id: requestBody.id
          new_id: requestBody.new_id
      - text: Update the HTML body of template {id} to {html_body}.
        slots:
          id: requestBody.id
          html_body: requestBody.html_body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search email templates
      effect: read
      questions:
      - Which email templates do I have?
      - Can I find templates by tag or name?
      instructions:
      - text: List my email templates.
      - text: Find templates matching {search_terms}.
        slots:
          search_terms: requestBody.search_terms
      - text: Show templates tagged {tags}.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/template/view'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one email template's details
      effect: read
      questions:
      - What does a specific template contain, including its HTML and variables?
      - Can I view the full content of one template by ID?
      instructions:
      - text: Show the details of template {id}.
        slots:
          id: requestBody.id
      - text: Get the HTML and text body of template {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'