Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Conversations API

4 actions 4 updates phrasing extends openapi/leadping-conversations-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 4

$.info

$.paths['/conversations/my'].post

$.paths['/conversations/{id}/mark-read'].post

$.paths['/conversations/lead/{leadId}'].post

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 Conversations API
  version: 1.0.0
extends: openapi/leadping-conversations-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: 3
- target: $.paths['/conversations/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List my inbox conversations
      effect: read
      questions:
      - What conversations are in my inbox right now?
      - Can I show archived conversations instead of active ones?
      instructions:
      - text: List my inbox conversations.
      - text: Show my conversations with archive filter {archiveFilter}.
        slots:
          archiveFilter: query.archiveFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{id}/mark-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a conversation as read
      effect: write
      questions:
      - How do I clear the unread state on an inbox conversation?
      - Can I mark one conversation read without opening it?
      instructions:
      - text: Mark conversation {id} as read.
        slots:
          id: path.id
      - text: Clear the unread flag on conversation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/lead/{leadId}'].post
  update:
    x-apievangelist-phrasing:
      intent: List conversations for a lead
      effect: read
      questions:
      - Which conversation threads exist for a particular lead?
      - Can I see all the threads I've had with one lead?
      instructions:
      - text: List conversations for lead {leadId}.
        slots:
          leadId: path.leadId
      - text: Show every inbox thread with lead {leadId}.
        slots:
          leadId: path.leadId
      method: generated
      generated: '2026-09-26'