# 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 Domains API
  version: 1.0.0
extends: openapi/postmark-domains-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: 9
- target: $.paths['/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List sending domains
      effect: read
      questions:
      - Which domains have I added to my Postmark account?
      - Can I page through all my sending domains a few at a time?
      instructions:
      - text: List the first {count} domains on my account.
        slots:
          count: query.count
      - text: Show my domains, skipping the first {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sending domain
      effect: write
      questions:
      - How do I add a new domain so I can send email from it?
      - Can I set a custom Return-Path when I register a domain?
      instructions:
      - text: Add the domain {name} to my account.
        slots:
          name: requestBody.Name
      - text: Register domain {name} with Return-Path domain {return_path}.
        slots:
          name: requestBody.Name
          return_path: requestBody.ReturnPathDomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's DNS and verification status
      effect: read
      questions:
      - What DKIM and Return-Path records does one of my domains need?
      - Has my domain's DNS verification gone through yet?
      instructions:
      - text: Get the details for domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Show the DNS records and verification state of domain {domainid}.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's Return-Path
      effect: write
      questions:
      - How do I change the Return-Path on a domain I already added?
      - Can I update an existing domain's custom bounce domain?
      instructions:
      - text: Set the Return-Path of domain {domainid} to {return_path}.
        slots:
          domainid: path.domainid
          return_path: requestBody.ReturnPathDomain
      - text: Update domain {domainid} with a new Return-Path domain.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a sending domain
      effect: destructive
      questions:
      - How do I remove a domain I no longer send from?
      - Can I delete a domain from my account entirely?
      instructions:
      - text: Delete domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Remove domain {domainid} from my account permanently.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}/verifydkim'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify a domain's DKIM record
      effect: write
      questions:
      - I added the DKIM TXT record — how do I get it checked?
      - Can I trigger a DKIM DNS check for my domain on demand?
      instructions:
      - text: Check the DKIM DNS record for domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Request DKIM verification on domain {domainid}.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}/verifyreturnpath'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify a domain's Return-Path CNAME
      effect: write
      questions:
      - How do I confirm my Return-Path CNAME is set up correctly?
      - Can I ask for the custom Return-Path DNS to be re-checked?
      instructions:
      - text: Verify the Return-Path DNS for domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Run a Return-Path CNAME check on domain {domainid}.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}/verifyspf'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a domain's SPF record
      effect: write
      questions:
      - How do I get the SPF record on my domain verified?
      - Can I re-run the SPF DNS check after updating my domain's TXT record?
      instructions:
      - text: Verify SPF for domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Check whether domain {domainid} has a valid SPF record now.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domainid}/rotatedkim'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a domain's DKIM key
      effect: write
      questions:
      - How do I rotate the DKIM key on my domain?
      - Where do the new DKIM values show up until DNS confirms them?
      instructions:
      - text: Rotate the DKIM key for domain {domainid}.
        slots:
          domainid: path.domainid
      - text: Generate a replacement DKIM key on domain {domainid} and show the pending DNS values.
        slots:
          domainid: path.domainid
      method: generated
      generated: '2026-10-01'