Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Message Identifier API

3 actions 3 updates phrasing extends openapi/postmark-message-identifier-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['/messages/outbound/clicks/{messageid}'].get
$.paths['/messages/outbound/opens/{messageid}'].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 Message Identifier API
  version: 1.0.0
extends: openapi/postmark-message-identifier-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['/messages/outbound/clicks/{messageid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link clicks for one sent email
      effect: read
      questions:
      - Did anyone click the links in one particular email I sent?
      - Can I see each click event recorded for a single message?
      instructions:
      - text: Show link clicks for message {messageid}.
        slots:
          messageid: path.messageid
      - text: List the first {count} click events on sent email {messageid}.
        slots:
          count: query.count
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/opens/{messageid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get opens for one sent email
      effect: read
      questions:
      - Has a specific email I sent been opened, and how many times?
      - Can I see every open event recorded for one message?
      instructions:
      - text: Show the opens for message {messageid}.
        slots:
          messageid: path.messageid
      - text: List the first {count} open events on sent email {messageid}.
        slots:
          count: query.count
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'