# 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 Pipelines API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-pipelines-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: 17
- target: $.paths['/api/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List sales pipelines
      effect: read
      questions:
      - Which sales pipelines are set up in my workspace?
      - Can I include hidden pipelines when listing them?
      instructions:
      - text: List my pipelines, includeHidden {includeHidden}.
        slots:
          includeHidden: query.includeHidden
      - text: Show all pipelines including hidden ones ({includeHidden}).
        slots:
          includeHidden: query.includeHidden
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales pipeline
      effect: write
      questions:
      - How do I set up a new sales pipeline?
      - Can a new pipeline use its own currency and be the default?
      instructions:
      - text: Create a pipeline named {name}.
        slots:
          name: requestBody.name
      - text: Create pipeline {name} in {currency} and make it the default ({isDefault}).
        slots:
          name: requestBody.name
          currency: requestBody.currency
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/automation-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: View automation logs across all pipelines
      effect: read
      questions:
      - What have stage automations done across all my pipelines recently?
      - Can I see every automation run that touched a particular lead?
      instructions:
      - text: Show the last {limit} automation runs across pipelines for lead {leadId}.
        slots:
          limit: query.limit
          leadId: query.leadId
      - text: List global pipeline automation logs for lead {leadId}, limit {limit}.
        slots:
          leadId: query.leadId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline
      effect: read
      questions:
      - How is a particular pipeline configured?
      - Can I fetch one pipeline's settings by its id?
      instructions:
      - text: Show pipeline {id}.
        slots:
          id: path.id
      - text: Get the configuration of pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline
      effect: destructive
      questions:
      - How do I remove a pipeline I no longer use?
      - Can I delete a whole sales pipeline?
      instructions:
      - text: Delete pipeline {id}.
        slots:
          id: path.id
      - text: Remove the sales pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pipeline's settings
      effect: write
      questions:
      - How do I rename a pipeline or change its currency?
      - Can I hide or deactivate an existing pipeline?
      instructions:
      - text: Rename pipeline {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set pipeline {id} hidden to {isHidden}.
        slots:
          id: path.id
          isHidden: requestBody.isHidden
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}/stages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a stage to a pipeline
      effect: write
      questions:
      - How do I add a new stage to a sales pipeline?
      - Can I set a win probability and rotting days on a new stage?
      instructions:
      - text: Add a stage named {name} to pipeline {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add stage {name} to pipeline {id} with probability {probability} and rotting after {rottingDays} days.
        slots:
          name: requestBody.name
          id: path.id
          probability: requestBody.probability
          rottingDays: requestBody.rottingDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{pipelineId}/stages/reorder'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder a pipeline's stages
      effect: write
      questions:
      - How do I change the order of stages in a pipeline?
      - Can I rearrange pipeline columns by passing stage ids in order?
      instructions:
      - text: Reorder the stages of pipeline {pipelineId} as {stageIds}.
        slots:
          pipelineId: path.pipelineId
          stageIds: requestBody.stageIds
      - text: 'Put pipeline {pipelineId}''s stages in this order: {stageIds}.'
        slots:
          pipelineId: path.pipelineId
          stageIds: requestBody.stageIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{pipelineId}/stages/{stageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline stage
      effect: destructive
      questions:
      - How do I remove a stage from a pipeline?
      - Can I delete a stage I no longer need?
      instructions:
      - text: Delete stage {stageId} from pipeline {pipelineId}.
        slots:
          stageId: path.stageId
          pipelineId: path.pipelineId
      - text: Remove stage {stageId} in pipeline {pipelineId}.
        slots:
          stageId: path.stageId
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{pipelineId}/stages/{stageId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pipeline stage
      effect: write
      questions:
      - How do I rename a stage or change its color?
      - Can I change an existing stage's win probability or hide it?
      instructions:
      - text: Rename stage {stageId} in pipeline {pipelineId} to {name}.
        slots:
          stageId: path.stageId
          pipelineId: path.pipelineId
          name: requestBody.name
      - text: Set stage {stageId} of pipeline {pipelineId} to probability {probability}.
        slots:
          stageId: path.stageId
          pipelineId: path.pipelineId
          probability: requestBody.probability
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/stages/{stageId}/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: List automations on a stage
      effect: read
      questions:
      - What automations fire when a lead enters a stage?
      - Which automations are attached to a given pipeline stage?
      instructions:
      - text: List automations on stage {stageId}.
        slots:
          stageId: path.stageId
      - text: Show what automations run for stage {stageId}.
        slots:
          stageId: path.stageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/stages/{stageId}/automations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an automation to a stage
      effect: write
      questions:
      - How do I make something happen automatically when a lead reaches a stage?
      - Can I create a stage automation that starts out disabled?
      instructions:
      - text: On stage {stageId}, when {trigger} run {action} with config {config}.
        slots:
          stageId: path.stageId
          trigger: requestBody.trigger
          action: requestBody.action
          config: requestBody.config
      - text: 'Create automation {name} on stage {stageId}: trigger {trigger}, action {action}, config {config}.'
        slots:
          name: requestBody.name
          stageId: path.stageId
          trigger: requestBody.trigger
          action: requestBody.action
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/automations/{automationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stage automation
      effect: destructive
      questions:
      - How do I remove an automation from a pipeline stage?
      - Can I delete a stage automation entirely rather than just disable it?
      instructions:
      - text: Delete automation {automationId}.
        slots:
          automationId: path.automationId
      - text: Remove stage automation {automationId}.
        slots:
          automationId: path.automationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/automations/{automationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a stage automation
      effect: write
      questions:
      - How do I turn off a stage automation without deleting it?
      - Can I change the trigger or action of an existing automation?
      instructions:
      - text: Set automation {automationId} active to {isActive}.
        slots:
          automationId: path.automationId
          isActive: requestBody.isActive
      - text: Change automation {automationId} to trigger on {trigger}.
        slots:
          automationId: path.automationId
          trigger: requestBody.trigger
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/automations/{automationId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: View execution logs for one automation
      effect: read
      questions:
      - Did a specific stage automation run, and did it succeed?
      - Where can I see the run history of a single automation?
      instructions:
      - text: Show the last {limit} runs of automation {automationId}.
        slots:
          limit: query.limit
          automationId: path.automationId
      - text: Get execution logs for automation {automationId}, limit {limit}.
        slots:
          automationId: path.automationId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline's conversion stats
      effect: read
      questions:
      - How well do leads convert from stage to stage in a pipeline?
      - What are the conversion metrics for one pipeline?
      instructions:
      - text: Show conversion stats for pipeline {id}.
        slots:
          id: path.id
      - text: Get stage-by-stage metrics for pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/pipelines/{id}/migrate-legacy-stages'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate a pipeline's legacy stages
      effect: write
      questions:
      - How do I convert an old pipeline's embedded stage list into real stage records?
      - Can I upgrade legacy stage data on a pipeline?
      instructions:
      - text: Migrate legacy stages on pipeline {id}.
        slots:
          id: path.id
      - text: Convert pipeline {id}'s legacy stage JSON into stage rows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'