SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Pipelines API

5 actions 5 updates phrasing extends openapi/sendpulse-pipelines-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'].get
$.paths['/pipelines'].post
$.paths['/pipelines/{pipelineId}'].get
$.paths['/pipelines/{pipelineId}'].put

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 Pipelines API
  version: 1.0.0
extends: openapi/sendpulse-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: 4
- target: $.paths['/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal pipelines
      effect: read
      questions:
      - What sales pipelines do I have?
      - Can I see every pipeline with its statuses and settings?
      instructions:
      - text: List my deal pipelines.
      - text: Show all pipelines and their stages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deal pipeline
      effect: write
      questions:
      - How do I create a new sales pipeline?
      - Can I set pipeline settings when creating it?
      instructions:
      - text: Create a pipeline named {name}.
        slots:
          name: requestBody.name
      - text: Add a new deal pipeline {name} with settings {settings}.
        slots:
          name: requestBody.name
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline by ID
      effect: read
      questions:
      - Can I get the statuses and settings of one pipeline?
      - Who created a specific pipeline?
      instructions:
      - text: Get pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      - text: Show the details of pipeline {pipelineId}.
        slots:
          pipelineId: path.pipelineId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pipelines/{pipelineId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a pipeline
      effect: write
      questions:
      - Can I rename an existing pipeline?
      - Is it possible to change a pipeline's display order?
      instructions:
      - text: Rename pipeline {pipelineId} to {name}.
        slots:
          pipelineId: path.pipelineId
          name: requestBody.name
      - text: Set pipeline {pipelineId} order to {order}.
        slots:
          pipelineId: path.pipelineId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'