# 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 Bounces API
  version: 1.0.0
extends: openapi/postmark-bounces-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: 5
- target: $.paths['/deliverystats'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize bounces and inactive addresses
      effect: read
      questions:
      - How many of my recipient addresses are currently inactive because of bounces?
      - Can I see a breakdown of bounce totals by bounce type for my Postmark server?
      - What does the overall delivery health of my server look like right now?
      instructions:
      - text: Show the delivery stats summary for the server with token {server_token}.
        slots:
          server_token: header.X-Postmark-Server-Token
      - text: Give me the count of inactive emails and bounce totals per type.
      method: generated
      generated: '2026-10-01'
- 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/{bounceid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one bounce
      effect: read
      questions:
      - What exactly caused a particular bounce I'm looking at?
      - Can I see the full details of a single bounce by its ID?
      instructions:
      - text: Get the details of bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      - text: Tell me why bounce {bounceid} happened and whether it can be reactivated.
        slots:
          bounceid: path.bounceid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bounces/{bounceid}/dump'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the raw dump of a bounce
      effect: read
      questions:
      - Can I see the raw SMTP source of a bounced message?
      - Where do I get the full bounce dump to debug why a message failed?
      instructions:
      - text: Get the raw dump for bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      - text: Show the original bounce message source for bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bounces/{bounceid}/activate'].put
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a bounced address
      effect: write
      questions:
      - How do I start sending again to an address that was deactivated after a bounce?
      - Can I reactivate a recipient once they've fixed their mailbox?
      instructions:
      - text: Reactivate the address behind bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      - text: Activate bounce {bounceid} so we can email that recipient again.
        slots:
          bounceid: path.bounceid
      method: generated
      generated: '2026-10-01'