Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Server Inbound Rules API

4 actions 4 updates phrasing extends openapi/postmark-inbound-rules-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 4

$.info
$.paths['/triggers/inboundrules'].get
$.paths['/triggers/inboundrules'].post
$.paths['/triggers/inboundrules/{triggerid}'].delete

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 Server Inbound Rules API
  version: 1.0.0
extends: openapi/postmark-inbound-rules-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: 3
- target: $.paths['/triggers/inboundrules'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound blocking rules
      effect: read
      questions:
      - Which senders or domains am I currently blocking from my inbound stream?
      - Can I see all the inbound rule triggers on this server?
      instructions:
      - text: List the first {count} inbound rules.
        slots:
          count: query.count
      - text: Show my inbound blocking rules, skipping {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/inboundrules'].post
  update:
    x-apievangelist-phrasing:
      intent: Block an inbound sender or domain
      effect: write
      questions:
      - How do I stop inbound mail from a specific sender reaching my webhook?
      - Can I block an entire domain from my inbound processing?
      instructions:
      - text: Create an inbound rule blocking {rule}.
        slots:
          rule: requestBody.Rule
      - text: Block inbound email from {rule} on this server.
        slots:
          rule: requestBody.Rule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/inboundrules/{triggerid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an inbound blocking rule
      effect: destructive
      questions:
      - How do I unblock a sender I added an inbound rule for?
      - Can I delete a single inbound rule trigger?
      instructions:
      - text: Delete inbound rule {triggerid}.
        slots:
          triggerid: path.triggerid
      - text: Remove the inbound block with trigger ID {triggerid}.
        slots:
          triggerid: path.triggerid
      method: generated
      generated: '2026-10-01'