Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Lead Statuses API

5 actions 5 updates phrasing extends openapi/leadping-lead-statuses-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/lead-statuses'].get

$.paths['/lead-statuses'].post

$.paths['/lead-statuses/{id}'].put

$.paths['/lead-statuses/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Leadping Lead Statuses API
  version: 1.0.0
extends: openapi/leadping-lead-statuses-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['/lead-statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead statuses
      effect: read
      questions:
      - What lead statuses has my organization defined?
      - Which pipeline stages can I put leads in?
      instructions:
      - text: List my organization's lead statuses.
      - text: Show all active pipeline stages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lead-statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead status
      effect: write
      questions:
      - How do I add a new pipeline stage for leads?
      - Can I give a custom lead status its own color and position?
      instructions:
      - text: Create a lead status called {name}.
        slots:
          name: requestBody.name
      - text: Add pipeline stage {name} in color {color} at position {sortOrder}.
        slots:
          name: requestBody.name
          color: requestBody.color
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lead-statuses/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lead status
      effect: write
      questions:
      - How do I rename an existing pipeline stage?
      - Can I reorder my lead statuses?
      instructions:
      - text: Rename lead status {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move lead status {id} to sort position {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lead-statuses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a lead status
      effect: destructive
      questions:
      - How do I retire a pipeline stage without losing lead history?
      - What happens to leads' past records when a status is archived?
      instructions:
      - text: Archive lead status {id}.
        slots:
          id: path.id
      - text: Retire pipeline stage {id} so it can't be assigned anymore.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'