API Evangelist conversational phrasing for Live Direct Marketing Online Mail Routing Rules API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Mail Routing Rules API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-mail-routing-rules-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: 7
- target: $.paths['/api/mail-routing-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List all mail routing rules
      effect: read
      questions:
      - What mail routing rules do I have set up for incoming email?
      - Can I see every inbox routing rule in my workspace at once?
      instructions:
      - text: List all my mail routing rules.
      - text: Show every inbox routing rule configured for tenant {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mail routing rule
      effect: write
      questions:
      - How do I automatically move emails from a certain domain into a folder?
      - Can a new routing rule forward matching replies to a colleague?
      - Is it possible to route incoming mail using AI criteria instead of keywords?
      instructions:
      - text: Create a routing rule named {name} that moves mail from {fromDomain} into folder {targetFolder}.
        slots:
          name: requestBody.name
          fromDomain: requestBody.fromDomain
          targetFolder: requestBody.targetFolder
      - text: Add a new routing rule {name} that forwards emails with subject matching {subjectPattern} to {forwardTo}.
        slots:
          name: requestBody.name
          subjectPattern: requestBody.subjectPattern
          forwardTo: requestBody.forwardTo
      - text: Set up rule {name} that marks mail from {fromEmail} as read and stops further processing.
        slots:
          name: requestBody.name
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mail routing rule
      effect: read
      questions:
      - What conditions and action does a specific routing rule have?
      - Can I look up the details of one mail routing rule by its id?
      instructions:
      - text: Show me mail routing rule {id}.
        slots:
          id: path.id
      - text: Get the match conditions and target folder of routing rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mail routing rule
      effect: destructive
      questions:
      - How do I permanently remove a mail routing rule I no longer need?
      - Can I delete an inbox routing rule rather than just disabling it?
      instructions:
      - text: Delete mail routing rule {id}.
        slots:
          id: path.id
      - text: Remove routing rule {id} from my inbox rules for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a mail routing rule
      effect: write
      questions:
      - How do I change the target folder of an existing routing rule?
      - Can I edit the keywords or sort order on a routing rule I already created?
      instructions:
      - text: Change existing routing rule {id} to move matching mail into {targetFolder}.
        slots:
          id: path.id
          targetFolder: requestBody.targetFolder
      - text: Update the keywords on routing rule {id} to {keywords}.
        slots:
          id: path.id
          keywords: requestBody.keywords
      - text: Set the priority of routing rule {id} to sort order {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules/{id}/toggle'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn a mail routing rule on or off
      effect: write
      questions:
      - How do I temporarily pause a routing rule without deleting it?
      - Can I flip a disabled mail rule back on with one call?
      instructions:
      - text: Toggle routing rule {id} on or off.
        slots:
          id: path.id
      - text: Flip the active switch on mail routing rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-routing-rules/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Dry-run an email against routing rules
      effect: read
      questions:
      - Which of my active routing rules would catch a given email?
      - Can I test my mail rules with a sample message before it really arrives?
      instructions:
      - text: Dry-run a sample email through my active routing rules and tell me which one matches.
      - text: Test the active mail routing rules against a synthetic message without moving anything.
      method: generated
      generated: '2026-10-01'