Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Account Sender Signatures API

9 actions 9 updates phrasing extends openapi/postmark-sender-signatures-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 9

$.info
$.paths['/senders'].get
$.paths['/senders'].post
$.paths['/senders/{signatureid}'].get
$.paths['/senders/{signatureid}'].put
$.paths['/senders/{signatureid}'].delete
$.paths['/senders/{signatureid}/resend'].post
$.paths['/senders/{signatureid}/verifyspf'].post
$.paths['/senders/{signatureid}/requestnewdkim'].post

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 Account Sender Signatures API
  version: 1.0.0
extends: openapi/postmark-sender-signatures-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: 8
- target: $.paths['/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender signatures
      effect: read
      questions:
      - Which from addresses are registered as sender signatures on my account?
      - Can I page through all my sender signatures?
      instructions:
      - text: List the first {count} sender signatures.
        slots:
          count: query.count
      - text: Show my sender signatures after skipping {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new from address
      effect: write
      questions:
      - How do I add a new from address so I can send email as it?
      - Can I set a reply-to address when creating a sender signature?
      instructions:
      - text: Create a sender signature for {from_email} named {name}.
        slots:
          from_email: requestBody.FromEmail
          name: requestBody.Name
      - text: Add sender {from_email} with replies going to {reply_to}.
        slots:
          from_email: requestBody.FromEmail
          reply_to: requestBody.ReplyToEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender signature
      effect: read
      questions:
      - Is my sender signature confirmed, and what DNS does it still need?
      - Can I view the settings of one sender signature?
      instructions:
      - text: Get sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      - text: Show the confirmation and DNS status of sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sender signature
      effect: write
      questions:
      - How do I change the display name on an existing sender signature?
      - Can I change the reply-to address of a sender I already registered?
      instructions:
      - text: Rename sender signature {signatureid} to {name}.
        slots:
          signatureid: path.signatureid
          name: requestBody.Name
      - text: Set the reply-to on sender signature {signatureid} to {reply_to}.
        slots:
          signatureid: path.signatureid
          reply_to: requestBody.ReplyToEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender signature
      effect: destructive
      questions:
      - How do I remove a from address I no longer use?
      - Can I delete a sender signature from my account?
      instructions:
      - text: Delete sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      - text: Remove the from address registered as signature {signatureid}.
        slots:
          signatureid: path.signatureid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a sender confirmation email
      effect: write
      questions:
      - The confirmation email for my new sender never arrived — can I get it resent?
      - How do I re-send the signature confirmation link?
      instructions:
      - text: Resend the confirmation email for sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      - text: Send the confirmation link for signature {signatureid} again.
        slots:
          signatureid: path.signatureid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}/verifyspf'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify SPF for a sender signature
      effect: write
      questions:
      - How do I get SPF checked for a sender signature's domain?
      - Can I re-run the SPF verification on one of my sender signatures?
      instructions:
      - text: Verify SPF on sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      - text: Check the SPF DNS record behind sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/senders/{signatureid}/requestnewdkim'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a new DKIM key for a sender
      effect: write
      questions:
      - How do I get a fresh DKIM key for a sender signature?
      - Where do the pending DKIM host and value appear for a sender signature?
      instructions:
      - text: Request a new DKIM key for sender signature {signatureid}.
        slots:
          signatureid: path.signatureid
      - text: Generate fresh DKIM values for signature {signatureid} and show the pending records.
        slots:
          signatureid: path.signatureid
      method: generated
      generated: '2026-10-01'