# 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 Inbound API
  version: 1.0.0
extends: openapi/mailchimp-inbound-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: 9
- target: $.paths['/inbound/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: List inbound email domains
      effect: read
      questions:
      - Which domains are set up to receive inbound email on my transactional account?
      - Can I see all my inbound domains and whether their MX records are valid?
      instructions:
      - text: List my inbound domains using key {key}.
        slots:
          key: requestBody.key
      - text: Show every domain configured for inbound delivery, API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/add-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an inbound email domain
      effect: write
      questions:
      - How do I start receiving inbound email for my own domain?
      - Can I register a new domain for inbound mail processing?
      instructions:
      - text: Add {domain} as an inbound domain using key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      - text: Set up inbound delivery for domain {domain}, API key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/check-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Check MX settings for an inbound domain
      effect: read
      questions:
      - Are the MX records for my inbound domain pointed correctly?
      - Can I verify an inbound domain's DNS after adding it?
      instructions:
      - text: Check the MX settings for inbound domain {domain} using key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      - text: Verify that {domain} is ready to receive inbound mail, API key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/delete-domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbound email domain
      effect: destructive
      questions:
      - What happens to incoming mail when I remove an inbound domain?
      - Can I stop processing inbound email for a domain entirely?
      instructions:
      - text: Delete inbound domain {domain} using key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      - text: Stop routing inbound mail for {domain} immediately, API key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/routes'].post
  update:
    x-apievangelist-phrasing:
      intent: List inbound routes for a domain or SMS number
      effect: read
      questions:
      - Which mailbox patterns and webhooks are routing mail for an inbound domain?
      - Can I see the inbound routes set up for my SMS phone number?
      instructions:
      - text: List inbound routes for domain {domain} using key {key}.
        slots:
          domain: requestBody.domain
          key: requestBody.key
      - text: Show the inbound routes for SMS number {phone}, API key {key}.
        slots:
          phone: requestBody.phone
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/add-route'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an inbound route to a webhook
      effect: write
      questions:
      - How do I forward mail sent to support@ on my inbound domain to a webhook?
      - Can I route inbound SMS messages to a URL?
      instructions:
      - text: Route mail matching {pattern} on {domain} to webhook {url}, key {key}.
        slots:
          pattern: requestBody.pattern
          domain: requestBody.domain
          url: requestBody.url
          key: requestBody.key
      - text: Add an inbound route sending SMS to {phone} on to {url}, API key {key}.
        slots:
          phone: requestBody.phone
          url: requestBody.url
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/update-route'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an inbound mailbox route
      effect: write
      questions:
      - Can I change the webhook URL an existing inbound route posts to?
      - How do I edit the mailbox pattern on a route I already created?
      instructions:
      - text: Point existing inbound route {id} at webhook {url} using key {key}.
        slots:
          id: requestBody.id
          url: requestBody.url
          key: requestBody.key
      - text: Change the pattern of inbound route {id} to {pattern}, API key {key}.
        slots:
          id: requestBody.id
          pattern: requestBody.pattern
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/delete-route'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbound mailbox route
      effect: destructive
      questions:
      - Can I remove a single inbound route without deleting the whole domain?
      - What's the way to stop one mailbox pattern from posting to its webhook?
      instructions:
      - text: Delete inbound route {id} using key {key}.
        slots:
          id: requestBody.id
          key: requestBody.key
      - text: Remove the mailbox route {id}, API key {key}.
        slots:
          id: requestBody.id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inbound/send-raw'].post
  update:
    x-apievangelist-phrasing:
      intent: Inject a raw MIME message into inbound processing
      effect: write
      questions:
      - Can I test my inbound webhook by feeding it a raw MIME email as if it arrived over SMTP?
      - How do I replay an inbound message through my routes?
      instructions:
      - text: 'Send this raw MIME message to the inbound hook: {raw_message}, key {key}.'
        slots:
          raw_message: requestBody.raw_message
          key: requestBody.key
      - text: Inject raw message {raw_message} addressed to {to} from {mail_from} into inbound processing, API key {key}.
        slots:
          raw_message: requestBody.raw_message
          to: requestBody.to
          mail_from: requestBody.mail_from
          key: requestBody.key
      method: generated
      generated: '2026-09-26'