Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Templates API

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

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/templates/push'].put
$.paths['/email/withTemplate'].post
$.paths['/email/batchWithTemplates'].post
$.paths['/templates'].get
$.paths['/templates'].post
$.paths['/templates/{templateIdOrAlias}'].get
$.paths['/templates/{templateIdOrAlias}'].put
$.paths['/templates/{templateIdOrAlias}'].delete
$.paths['/templates/validate'].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 Postmark Templates API
  version: 1.0.0
extends: openapi/postmark-templates-api-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: 9
- target: $.paths['/templates/push'].put
  update:
    x-apievangelist-phrasing:
      intent: Copy templates from one server to another
      effect: write
      questions:
      - How do I copy my templates from staging to production?
      - Can I preview which templates would change before pushing them to another server?
      instructions:
      - text: Push templates from server {source_server} to server {destination_server}.
        slots:
          source_server: requestBody.SourceServerId
          destination_server: requestBody.DestinationServerId
      - text: Dry-run a template push from {source_server} to {destination_server} with perform changes set to {perform_changes}.
        slots:
          source_server: requestBody.SourceServerId
          destination_server: requestBody.DestinationServerId
          perform_changes: requestBody.PerformChanges
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/withTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Send one email from a saved template
      effect: write
      questions:
      - How do I send a single message based on a template I've stored?
      - Can I reference a template by its alias instead of its numeric ID when sending?
      instructions:
      - text: Send template {template_alias} to {to} from {from} using model {model}.
        slots:
          template_alias: requestBody.TemplateAlias
          to: requestBody.To
          from: requestBody.From
          model: requestBody.TemplateModel
      - text: Email {to} with template {template_id} and inline the CSS.
        slots:
          to: requestBody.To
          template_id: requestBody.TemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/batchWithTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Send many templated emails at once
      effect: write
      questions:
      - Can I send a whole list of template-based emails in one request?
      - What's the way to bulk-send personalized messages from templates?
      instructions:
      - text: 'Batch-send these template messages: {messages}.'
        slots:
          messages: requestBody.Messages
      - text: Send each templated email in {messages} in a single request.
        slots:
          messages: requestBody.Messages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List the server's templates
      effect: read
      questions:
      - Which email templates exist on this server?
      - Can I page through my templates to find an alias?
      instructions:
      - text: List the first {count} templates.
        slots:
          count: query.Count
      - text: Show my templates, skipping {offset}.
        slots:
          offset: query.Offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a template
      effect: write
      questions:
      - How do I create a new email template on my server?
      - Can I give a new template an alias so I can send by name?
      instructions:
      - text: Create a template named {name} with subject {subject}.
        slots:
          name: requestBody.Name
          subject: requestBody.Subject
      - text: Create template {name} with alias {alias}, subject {subject} and HTML {html_body}.
        slots:
          name: requestBody.Name
          alias: requestBody.Alias
          subject: requestBody.Subject
          html_body: requestBody.HtmlBody
      - text: Add a new text-only template {name} with subject {subject} and body {text_body} on server {server_token}.
        slots:
          name: requestBody.Name
          subject: requestBody.Subject
          text_body: requestBody.TextBody
          server_token: header.X-Postmark-Server-Token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/{templateIdOrAlias}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template
      effect: read
      questions:
      - What does the HTML and subject of one of my templates look like?
      - Can I fetch a template by its alias?
      instructions:
      - text: Get template {template}.
        slots:
          template: path.templateIdOrAlias
      - text: Show the subject, HTML and text body of template {template}.
        slots:
          template: path.templateIdOrAlias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/{templateIdOrAlias}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a template
      effect: write
      questions:
      - How do I change the subject line of an existing template?
      - Can I rename a template or give it a new alias?
      instructions:
      - text: Change the subject of template {template} to {subject}.
        slots:
          template: path.templateIdOrAlias
          subject: requestBody.Subject
      - text: Replace the HTML body of template {template} with {html_body}.
        slots:
          template: path.templateIdOrAlias
          html_body: requestBody.HtmlBody
      - text: Give template {template} the alias {alias}.
        slots:
          template: path.templateIdOrAlias
          alias: requestBody.Alias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/{templateIdOrAlias}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a template
      effect: destructive
      questions:
      - How do I remove a template I no longer use?
      - Can I delete a template by its alias?
      instructions:
      - text: Delete template {template}.
        slots:
          template: path.templateIdOrAlias
      - text: Remove the template with ID or alias {template}.
        slots:
          template: path.templateIdOrAlias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate and preview template content
      effect: read
      questions:
      - Will my template syntax render correctly before I save it?
      - Can I preview a template's output with sample data?
      instructions:
      - text: Validate this template subject {subject} and HTML {html_body}.
        slots:
          subject: requestBody.Subject
          html_body: requestBody.HtmlBody
      - text: Test-render text body {text_body} with model {render_model}.
        slots:
          text_body: requestBody.TextBody
          render_model: requestBody.TestRenderModel
      method: generated
      generated: '2026-10-01'