Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Server Server Configuration API

3 actions 3 updates phrasing extends openapi/postmark-server-configuration-api-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['/server'].get

$.paths['/server'].put

OpenAPI Overlay

# 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 Server Configuration API
  version: 1.0.0
extends: openapi/postmark-server-configuration-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: 2
- target: $.paths['/server'].get
  update:
    x-apievangelist-phrasing:
      intent: View this server's settings
      effect: read
      questions:
      - What webhook URLs and tracking settings is my current server using?
      - Is open tracking turned on for the server my token belongs to?
      instructions:
      - text: Show the configuration of the server with token {server_token}.
        slots:
          server_token: header.X-Postmark-Server-Token
      - text: Tell me the inbound domain and spam threshold set on my current server.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/server'].put
  update:
    x-apievangelist-phrasing:
      intent: Change this server's settings
      effect: write
      questions:
      - How do I point bounce webhooks for my current server at a new URL?
      - Can I turn on link tracking for the server I'm sending from?
      - Can I raise the inbound spam threshold on this server?
      instructions:
      - text: Set this server's bounce webhook to {bounce_hook_url}.
        slots:
          bounce_hook_url: requestBody.BounceHookUrl
      - text: Change my current server's inbound webhook to {inbound_hook_url} and inbound domain to {inbound_domain}.
        slots:
          inbound_hook_url: requestBody.InboundHookUrl
          inbound_domain: requestBody.InboundDomain
      - text: Set link tracking on the current server to {track_links}.
        slots:
          track_links: requestBody.TrackLinks
      method: generated
      generated: '2026-10-01'