# 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 Inbound Rules API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-inbound-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: 10
- target: $.paths['/api/inbound-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound rules
      effect: read
      questions:
      - Which inbound email rules are set up to turn messages into leads?
      - Can I see all my inbound routing rules?
      instructions:
      - text: List all my inbound rules.
      - text: Show every inbound email routing rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an inbound lead rule
      effect: write
      questions:
      - How do I automatically create a lead when an email matching certain keywords arrives?
      - Can an inbound rule use AI criteria to decide whether to make a lead?
      instructions:
      - text: Create inbound rule {name} that adds leads to pipeline {pipeline}.
        slots:
          name: requestBody.name
          pipeline: requestBody.pipelineId
      - text: Make rule {name} turning emails from {domain} into leads in pipeline {pipeline}.
        slots:
          name: requestBody.name
          domain: requestBody.fromDomain
          pipeline: requestBody.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound-rule automation events
      effect: read
      questions:
      - What have my inbound rules done recently?
      - Can I filter automation events by date range or event type?
      instructions:
      - text: List inbound-rule events of type {type} from {from} to {to}, page {page} of {size}.
        slots:
          type: query.eventType
          from: query.dateFrom
          to: query.dateTo
          page: query.page
          size: query.pageSize
      - text: Search automation events for {search} from source {source}, page {page}, {size} rows, {from} to {to}, type {type}.
        slots:
          search: query.search
          source: query.source
          page: query.page
          size: query.pageSize
          from: query.dateFrom
          to: query.dateTo
          type: query.eventType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inbound rule
      effect: read
      questions:
      - How is a specific inbound rule configured?
      - Can I look up one inbound rule's match conditions?
      instructions:
      - text: Show inbound rule {id}.
        slots:
          id: path.id
      - text: Get the conditions of inbound rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbound rule
      effect: destructive
      questions:
      - Can I delete an inbound rule I no longer use?
      - Is removing an inbound rule permanent?
      instructions:
      - text: Delete inbound rule {id}.
        slots:
          id: path.id
      - text: Remove routing rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an inbound rule
      effect: write
      questions:
      - Can I change the keywords or target stage of an existing inbound rule?
      - How do I edit an inbound rule's lead priority?
      instructions:
      - text: Change inbound rule {id}'s keywords to {keywords}.
        slots:
          id: path.id
          keywords: requestBody.keywords
      - text: Send leads from rule {id} to stage {stage}.
        slots:
          id: path.id
          stage: requestBody.stageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/reorder'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder inbound rules
      effect: write
      questions:
      - Can I change which inbound rule is evaluated first?
      - How do I set the priority order of inbound rules?
      instructions:
      - text: Reorder inbound rules as {ids}.
        slots:
          ids: requestBody.ids
      - text: Set inbound rule sort order to {items}.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/{id}/toggle'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn an inbound rule on or off
      effect: write
      questions:
      - Can I temporarily disable an inbound rule without deleting it?
      - How do I switch an inbound rule back on?
      instructions:
      - text: Toggle inbound rule {id} on or off.
        slots:
          id: path.id
      - text: Disable inbound rule {id} for now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Dry-run a message against inbound rules
      effect: read
      questions:
      - Can I test which inbound rule would catch a message without creating a lead?
      - Is there a dry run for my active inbound rules?
      instructions:
      - text: Dry-run a sample inbound message against my active rules.
      - text: Test which inbound rule a synthetic email would match.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inbound-rules/reapply'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-apply keyword routing to intake leads
      effect: write
      questions:
      - Can I rerun keyword routing on leads still sitting in the intake stage?
      - After changing rules, how do I re-route existing leads?
      instructions:
      - text: Re-apply keyword routing to leads in stage {stage} of pipeline {pipeline}.
        slots:
          stage: requestBody.fromStageId
          pipeline: requestBody.pipelineId
      - text: Re-route intake leads from stage {stage} in pipeline {pipeline}.
        slots:
          stage: requestBody.fromStageId
          pipeline: requestBody.pipelineId
      method: generated
      generated: '2026-10-01'