Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Batch API

3 actions 3 updates phrasing extends openapi/postmark-batch-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 3

$.info
$.paths['/email/batch'].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 Batch API
  version: 1.0.0
extends: openapi/postmark-batch-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: 2
- 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 my Postmark server in one request.
      - text: Submit these prepared messages together as one batch send.
      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.
      - text: Batch-send a template email to each recipient on this list.
      method: generated
      generated: '2026-10-01'