# 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 Status Changes API
  version: 1.0.0
extends: openapi/leadping-leadstatuschanges-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: 7
- target: $.paths['/leads/{leadId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a lead's current status
      effect: write
      questions:
      - How do I record an outcome like appointment set on a lead?
      - Can I schedule a callback time when changing a lead's status?
      instructions:
      - text: Set lead {leadId}'s status to type {type} with outcome {outcome}.
        slots:
          leadId: path.leadId
          type: requestBody.type
          outcome: requestBody.outcome
      - text: Mark lead {leadId} as {outcome} ({type}) with a callback at {callbackAt}.
        slots:
          leadId: path.leadId
          outcome: requestBody.outcome
          type: requestBody.type
          callbackAt: requestBody.callbackAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead-status-changes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a status history entry
      effect: read
      questions:
      - How do I look at a single past status change and its notes?
      - What follow-up context was saved with a particular outcome record?
      instructions:
      - text: Show status change {id}.
        slots:
          id: path.id
      - text: Get the notes on lead status history entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead-status-changes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a status history entry
      effect: write
      questions:
      - Can I fix a status change that was logged with the wrong outcome?
      - If I edit the latest status entry, does the lead's current status change too?
      instructions:
      - text: Update status history entry {id} to type {type}, outcome {outcome}.
        slots:
          id: path.id
          type: requestBody.type
          outcome: requestBody.outcome
      - text: 'Correct history entry {id}: outcome {outcome}, type {type}, notes {notes}.'
        slots:
          id: path.id
          outcome: requestBody.outcome
          type: requestBody.type
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead-status-changes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a status history entry
      effect: destructive
      questions:
      - How do I remove an outcome record that shouldn't show in reports?
      - Can a mistaken status change be deleted from a lead's history?
      instructions:
      - text: Delete status change {id}.
        slots:
          id: path.id
      - text: Remove lead status history entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead-status-changes/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List organization status history
      effect: read
      questions:
      - Which status changes happened across my whole organization?
      - Can I report on lead outcomes org-wide with filters?
      instructions:
      - text: List all lead status changes in my organization.
      - text: Search organization status history for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{leadId}/status-history'].get
  update:
    x-apievangelist-phrasing:
      intent: List a lead's status history
      effect: read
      questions:
      - What outcomes has a single lead gone through over time?
      - Who changed a lead's status and when?
      instructions:
      - text: Show the status history of lead {leadId}.
        slots:
          leadId: path.leadId
      - text: List prior outcomes and notes for lead {leadId}.
        slots:
          leadId: path.leadId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{leadId}/status-history/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a lead's status history
      effect: read
      questions:
      - Can I export one lead's outcome history for a handoff?
      - How do I get a packaged copy of a lead's status changes for audit?
      instructions:
      - text: Export the status history of lead {leadId}.
        slots:
          leadId: path.leadId
      - text: Download lead {leadId}'s outcome history as an export.
        slots:
          leadId: path.leadId
      method: generated
      generated: '2026-09-26'