Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Tags API

5 actions 5 updates phrasing extends openapi/leadping-tags-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['/tags'].get

$.paths['/tags'].post

$.paths['/tags/{id}'].put

$.paths['/tags/{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 Tags API
  version: 1.0.0
extends: openapi/leadping-tags-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead tags
      effect: read
      questions:
      - What tags does my organization use for leads?
      - Can I include archived tags in the list?
      instructions:
      - text: List my organization's tags.
      - text: 'List all tags including archived ones: {includeArchived}.'
        slots:
          includeArchived: query.includeArchived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead tag
      effect: write
      questions:
      - How do I create a new label for segmenting leads?
      - Can I pick a color for a new tag?
      instructions:
      - text: Create a tag called {name}.
        slots:
          name: requestBody.name
      - text: Add tag {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lead tag
      effect: write
      questions:
      - How do I rename an existing tag?
      - Can I change a tag's color or description later?
      instructions:
      - text: Rename tag {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change tag {id}'s color to {color}.
        slots:
          id: path.id
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a lead tag
      effect: destructive
      questions:
      - How do I retire a tag so nobody uses it on new leads?
      - Do leads keep an archived tag in their history?
      instructions:
      - text: Archive tag {id}.
        slots:
          id: path.id
      - text: Retire tag {id} from new segmentation.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'