# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postmark Messages API
  version: 1.0.0
extends: openapi/postmark-messages-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['/messages/outbound/clicks'].get
  update:
    x-apievangelist-phrasing:
      intent: Search link click events
      effect: read
      questions:
      - Which links in my emails are recipients clicking, and from where?
      - Can I filter link clicks by operating system or city?
      - What browsers do people click my email links from?
      instructions:
      - text: List link clicks across all messages tagged {tag}.
        slots:
          tag: query.tag
      - text: Show {count} clicks from {city} on OS family {os_family}.
        slots:
          count: query.count
          city: query.city
          os_family: query.os_family
      - text: Find link clicks by recipient {recipient}.
        slots:
          recipient: query.recipient
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/opens'].get
  update:
    x-apievangelist-phrasing:
      intent: Search email open events
      effect: read
      questions:
      - Who opened my emails, and from which email clients?
      - Can I filter open events by country or by mobile versus desktop?
      - Which recipients opened messages carrying a specific tag?
      instructions:
      - text: List opens across all messages tagged {tag}.
        slots:
          tag: query.tag
      - text: Show {count} email opens from {country} on platform {platform}.
        slots:
          count: query.count
          country: query.country
          platform: query.platform
      - text: Find open events by {recipient} using client {client_name}.
        slots:
          recipient: query.recipient
          client_name: query.client_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound/{messageid}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a sent email
      effect: read
      questions:
      - What happened to one specific email I sent — was it delivered?
      - Can I see the body and delivery events of a single outbound message?
      instructions:
      - text: Show the details and delivery events for sent message {messageid}.
        slots:
          messageid: path.messageid
      - text: Get outbound message {messageid}.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/messages/outbound'].get
  update:
    x-apievangelist-phrasing:
      intent: Search sent emails
      effect: read
      questions:
      - Did my password reset email actually go out to a particular customer?
      - Can I search outgoing messages by sender address and tag?
      - Which outbound emails are still queued rather than sent?
      instructions:
      - text: Search sent emails to {recipient} from {fromdate} to {todate}.
        slots:
          recipient: query.recipient
          fromdate: query.fromdate
          todate: query.todate
      - text: List the latest {count} outbound messages tagged {tag}.
        slots:
          count: query.count
          tag: query.tag
      - text: Find outbound messages from {fromemail} with status {status}.
        slots:
          fromemail: query.fromemail
          status: query.status
      method: generated
      generated: '2026-10-01'