# 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 Ips API
  version: 1.0.0
extends: openapi/mailchimp-ips-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: 13
- target: $.paths['/ips/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List dedicated sending IPs
      effect: read
      questions:
      - Which dedicated IPs does my Mailchimp Transactional account have?
      - Can I see all my dedicated sending IP addresses at once?
      instructions:
      - text: List my dedicated IPs.
      - text: Show every dedicated sending IP on the account for API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one dedicated IP
      effect: read
      questions:
      - What pool and warmup status does a particular dedicated IP have?
      - Can I look up the custom DNS of one of my sending IPs?
      instructions:
      - text: Get info about dedicated IP {ip}.
        slots:
          ip: requestBody.ip
      - text: Show the warmup and pool status of IP {ip}.
        slots:
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/provision'].post
  update:
    x-apievangelist-phrasing:
      intent: Request an additional dedicated IP
      effect: write
      questions:
      - How do I request another dedicated IP for my account?
      - How long does provisioning a new dedicated IP take?
      - Can I have a new IP start in warmup mode automatically?
      instructions:
      - text: Request a new dedicated IP.
      - text: Provision an additional dedicated IP into pool {pool} with warmup set to {warmup}.
        slots:
          pool: requestBody.pool
          warmup: requestBody.warmup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/start-warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Start warming up a dedicated IP
      effect: write
      questions:
      - How do I begin warming up a new dedicated IP?
      - How long does the IP warmup process take?
      instructions:
      - text: Start warmup for dedicated IP {ip}.
        slots:
          ip: requestBody.ip
      - text: Begin gradually shifting mail onto IP {ip}.
        slots:
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/cancel-warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a dedicated IP's warmup
      effect: write
      questions:
      - Can I stop the warmup process on a dedicated IP early?
      - What do I call to end IP warmup?
      instructions:
      - text: Cancel warmup for dedicated IP {ip}.
        slots:
          ip: requestBody.ip
      - text: Stop the warmup process on IP {ip}.
        slots:
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/set-pool'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a dedicated IP to another pool
      effect: write
      questions:
      - How do I move a dedicated IP into a different IP pool?
      - Can the target pool be created automatically if it doesn't exist yet?
      instructions:
      - text: Move IP {ip} to pool {pool}.
        slots:
          ip: requestBody.ip
          pool: requestBody.pool
      - text: Move dedicated IP {ip} into pool {pool}, creating the pool if needed ({create_pool}).
        slots:
          ip: requestBody.ip
          pool: requestBody.pool
          create_pool: requestBody.create_pool
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a dedicated IP
      effect: destructive
      questions:
      - How do I permanently remove a dedicated IP from my account?
      - Is deleting a dedicated IP reversible?
      instructions:
      - text: Delete dedicated IP {ip}.
        slots:
          ip: requestBody.ip
      - text: Permanently release IP address {ip} from my account.
        slots:
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/list-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: List dedicated IP pools
      effect: read
      questions:
      - What IP pools have I set up?
      - Can I see all my dedicated IP pools and what's in them?
      instructions:
      - text: List my dedicated IP pools.
      - text: Show all IP pools on the account tied to API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/pool-info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one IP pool
      effect: read
      questions:
      - Which IPs belong to a particular pool?
      - Can I describe a single dedicated IP pool by name?
      instructions:
      - text: Get info about IP pool {pool}.
        slots:
          pool: requestBody.pool
      - text: Show the IPs in pool {pool}.
        slots:
          pool: requestBody.pool
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/create-pool'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dedicated IP pool
      effect: write
      questions:
      - How do I create a new pool to group my dedicated IPs?
      - What happens if I create a pool with a name that already exists?
      instructions:
      - text: Create an IP pool named {pool}.
        slots:
          pool: requestBody.pool
      - text: Add a new dedicated IP pool called {pool}.
        slots:
          pool: requestBody.pool
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/delete-pool'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an empty IP pool
      effect: destructive
      questions:
      - Can I delete an IP pool that still has IPs in it?
      - How do I remove an IP pool I no longer use?
      instructions:
      - text: Delete IP pool {pool}.
        slots:
          pool: requestBody.pool
      - text: Remove the empty pool {pool}.
        slots:
          pool: requestBody.pool
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/check-custom-dns'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a custom reverse DNS for a dedicated IP
      effect: read
      questions:
      - Is my domain valid to use as the reverse DNS for a dedicated IP?
      - Can I check a custom DNS name before I apply it to an IP?
      instructions:
      - text: Test whether {domain} works as custom DNS for IP {ip}.
        slots:
          domain: requestBody.domain
          ip: requestBody.ip
      - text: Validate reverse DNS domain {domain} for dedicated IP {ip} without applying it.
        slots:
          domain: requestBody.domain
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ips/set-custom-dns'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the custom DNS name of a dedicated IP
      effect: write
      questions:
      - How do I configure a custom reverse DNS hostname on my dedicated IP?
      - Can I brand my sending IP with my own domain name?
      instructions:
      - text: Set the custom DNS of IP {ip} to {domain}.
        slots:
          ip: requestBody.ip
          domain: requestBody.domain
      - text: Apply {domain} as the reverse DNS name for dedicated IP {ip}.
        slots:
          domain: requestBody.domain
          ip: requestBody.ip
      method: generated
      generated: '2026-09-26'