SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Pipeline Steps API

5 actions 5 updates phrasing extends openapi/sendpulse-pipeline-steps-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/pipelines/{pipelineId}/steps'].get
$.paths['/pipelines/{pipelineId}/steps'].post
$.paths['/pipelines/{pipelineId}/steps/{stepId}'].put
$.paths['/pipelines/{pipelineId}/steps/{stepId}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse CRM Public Pipeline Steps API
  version: 1.0.0
extends: openapi/sendpulse-pipeline-steps-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: 4
- target: $.paths['/pipelines/{pipelineId}/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the stages of a sales pipeline
      effect: read
      questions:
      - What stages does my sales pipeline have?
      - In what order are the steps of a pipeline arranged?
      instructions:
      - text: List the steps of pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Show the stages in sales pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a stage to a sales pipeline
      effect: write
      questions:
      - How do I add a new stage to a deal pipeline?
      - Can I set a color and deadline hours for a new pipeline step?
      instructions:
      - text: Add step {name} to pipeline {pipelineId}.
        slots:
          name: requestBody.name
          pipelineId: path.pipelineId
      - text: Create stage {name} in pipeline {pipelineId} at position {order} with color {color}.
        slots:
          name: requestBody.name
          pipelineId: path.pipelineId
          order: requestBody.order
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/steps/{stepId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a stage in a sales pipeline
      effect: write
      questions:
      - Can I rename or recolor an existing pipeline stage?
      - Is it possible to reorder a step within a pipeline?
      instructions:
      - text: Rename step {stepId} in pipeline {pipelineId} to {name}.
        slots:
          stepId: path.stepId
          pipelineId: path.pipelineId
          name: requestBody.name
      - text: Move stage {stepId} of pipeline {pipelineId} to position {order}.
        slots:
          stepId: path.stepId
          pipelineId: path.pipelineId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}/steps/{stepId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stage from a sales pipeline
      effect: destructive
      questions:
      - Can I remove a stage from my pipeline?
      - What's the way to delete a pipeline step I don't use?
      instructions:
      - text: Delete step {stepId} from pipeline {pipelineId}.
        slots:
          stepId: path.stepId
          pipelineId: path.pipelineId
      - text: Remove stage {stepId} in pipeline {pipelineId}.
        slots:
          stepId: path.stepId
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'