# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mailchimp Transactional Senders API
  version: 1.0.0
extends: openapi/mailchimp-senders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/senders/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List senders that have used the account
      effect: read
      questions:
      - Which from addresses have tried to send through my Transactional account?
      - Can I see every sender address that has used this account?
      instructions:
      - text: List the senders that have used my account.
      - text: Show all sender addresses seen on API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: List sender domains on the account
      effect: read
      questions:
      - What sending domains have been added to my Transactional account?
      - Which of my sender domains are verified?
      instructions:
      - text: List my sender domains.
      - text: Show the sender domains registered under API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/add-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender domain
      effect: write
      questions:
      - Can I add a sending domain before I actually send from it?
      - How do I register a new sender domain on my account?
      instructions:
      - text: Add sender domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Register {domain} as a sending domain ahead of time.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/delete-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an unverified sender domain
      effect: destructive
      questions:
      - How do I remove a sender domain I added by mistake?
      - Why can't I delete a verified sender domain through the API?
      instructions:
      - text: Delete sender domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Remove the unverified sending domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/check-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a sender domain's SPF and DKIM
      effect: read
      questions:
      - Are the SPF and DKIM records set up correctly for my sending domain?
      - Is my sender domain verified yet?
      instructions:
      - text: Check the SPF and DKIM settings for {domain}.
        slots:
          domain: requestBody.domain
      - text: Verify the DNS authentication status of sending domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/verify-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a domain ownership verification email
      effect: write
      questions:
      - How do I prove I own a sending domain?
      - Which mailbox will receive the domain verification email?
      instructions:
      - text: Send a verification email for {domain} to mailbox {mailbox}.
        slots:
          domain: requestBody.domain
          mailbox: requestBody.mailbox
      - text: Start ownership verification of {domain} using the {mailbox} inbox.
        slots:
          domain: requestBody.domain
          mailbox: requestBody.mailbox
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get stats for one sender address
      effect: read
      questions:
      - How are emails from a specific sender address performing?
      - What are the recent aggregate stats for one from address?
      instructions:
      - text: Get sender info for {address}.
        slots:
          address: requestBody.address
      - text: Show recent sending totals for from address {address}.
        slots:
          address: requestBody.address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/time-series'].post
  update:
    x-apievangelist-phrasing:
      intent: Get hourly sending history for a sender
      effect: read
      questions:
      - Can I see hour-by-hour stats for a sender over the last 30 days?
      - What does the recent sending history look like for one address?
      instructions:
      - text: Get the hourly history for sender {address}.
        slots:
          address: requestBody.address
      - text: Show 30 days of hourly stats for sender address {address}.
        slots:
          address: requestBody.address
      method: generated
      generated: '2026-09-26'