Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Bounces API

3 actions 3 updates phrasing extends openapi/postmark-bounces-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['/bounces'].get
$.paths['/bounces/tags'].get

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 Bounces API
  version: 1.0.0
extends: openapi/postmark-bounces-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['/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: List bounced emails
      effect: read
      questions:
      - Which emails bounced on my server last week?
      - Can I filter bounces to only the addresses that got deactivated?
      - How do I find every bounce for one recipient email address?
      - Is there a way to list hard bounces that carry a specific tag?
      instructions:
      - text: List the first {count} bounces of type {type}.
        slots:
          count: query.count
          type: query.type
      - text: Find bounces for {email} between {fromdate} and {todate}.
        slots:
          email: query.emailFilter
          fromdate: query.fromdate
          todate: query.todate
      - text: Show bounces tagged {tag} that left the address inactive.
        slots:
          tag: query.tag
      - text: Look up the bounce record for message {message_id}.
        slots:
          message_id: query.messageID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bounces/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags that have bounces
      effect: read
      questions:
      - Which of my message tags have bounced emails?
      - What tags show up across my bounces?
      instructions:
      - text: List the tags attached to my bounced messages.
      - text: Show every tag that has at least one bounce.
      method: generated
      generated: '2026-10-01'