Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Server Sending API

5 actions 5 updates phrasing extends openapi/postmark-sending-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 5

$.info
$.paths['/email'].post
$.paths['/email/batch'].post
$.paths['/email/withTemplate'].post
$.paths['/email/batchWithTemplates'].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 Server Sending API
  version: 1.0.0
extends: openapi/postmark-sending-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: 4
- target: $.paths['/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a single email
      effect: write
      questions:
      - How do I send one transactional email with Postmark?
      - Can I turn on open and click tracking for an individual email?
      - Is there a limit on how many recipients one message can have?
      instructions:
      - text: Email {to} from {from} with subject {subject} and body {text_body}.
        slots:
          to: requestBody.To
          from: requestBody.From
          subject: requestBody.Subject
          text_body: requestBody.TextBody
      - text: Send an HTML email {html_body} to {to}, tagged {tag}, with open tracking on.
        slots:
          html_body: requestBody.HtmlBody
          to: requestBody.To
          tag: requestBody.Tag
      - text: Send {subject} to {to} and copy {cc}.
        slots:
          subject: requestBody.Subject
          to: requestBody.To
          cc: requestBody.Cc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a batch of emails in one call
      effect: write
      questions:
      - Can I send many different emails in a single API request?
      - What's the way to push a batch of non-template messages at once?
      instructions:
      - text: Send this batch of emails through the server with token {server_token}.
        slots:
          server_token: header.X-Postmark-Server-Token
      - text: Submit these prepared messages together as one batch send.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/withTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email from a template
      effect: write
      questions:
      - How do I send an email using one of my saved templates?
      - Can I fill template variables with my own data when sending?
      instructions:
      - text: Send template {template_alias} to {to} from {from} with model {model}.
        slots:
          template_alias: requestBody.TemplateAlias
          to: requestBody.To
          from: requestBody.From
          model: requestBody.TemplateModel
      - text: Email {to} using template ID {template_id}.
        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 a batch of templated emails
      effect: write
      questions:
      - Can I send lots of personalized template emails in one request?
      - How do I batch-send messages that each use a template?
      instructions:
      - text: 'Send these templated messages as one batch: {messages}.'
        slots:
          messages: requestBody.Messages
      - text: Batch-send template emails for each recipient in {messages}.
        slots:
          messages: requestBody.Messages
      method: generated
      generated: '2026-10-01'