# 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 Allowlists API
  version: 1.0.0
extends: openapi/mailchimp-allow-lists-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: 3
- target: $.paths['/allowlists/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email address to the allowlist
      effect: write
      questions:
      - How do I make sure transactional mail to a specific address is never rejected?
      - If an address is on my denylist, does adding it to the allowlist clear that entry?
      instructions:
      - text: Add {email} to my rejection allowlist using key {key}.
        slots:
          email: requestBody.email
          key: requestBody.key
      - text: Allowlist {email} with the note {comment}, API key {key}.
        slots:
          email: requestBody.email
          comment: requestBody.comment
          key: requestBody.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowlists/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List or search allowlisted addresses
      effect: read
      questions:
      - Which email addresses are on my rejection allowlist?
      - Can I search the allowlist by an address prefix, and how many results come back?
      instructions:
      - text: Show my allowlisted email addresses using key {key}.
        slots:
          key: requestBody.key
      - text: Search the allowlist for addresses starting with {email}, API key {key}.
        slots:
          email: requestBody.email
          key: requestBody.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowlists/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove an address from the allowlist
      effect: destructive
      questions:
      - Can I take an email address back off my allowlist?
      - What's the way to un-allowlist an address that shouldn't be exempt anymore?
      instructions:
      - text: Remove {email} from the allowlist using key {key}.
        slots:
          email: requestBody.email
          key: requestBody.key
      - text: Delete the allowlist entry for {email}, API key {key}.
        slots:
          email: requestBody.email
          key: requestBody.key
      method: generated
      generated: '2026-10-01'