# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Leadping Leads API
  version: 1.0.0
extends: openapi/leadping-leads-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: 14
- target: $.paths['/leads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead from an external source
      effect: write
      questions:
      - How do I push a lead captured on another system into Leadping with structured contact data?
      - Can a new lead be created with tags already attached?
      instructions:
      - text: Create a lead with contact details {contact} and customer {customer}.
        slots:
          contact: requestBody.contact
          customer: requestBody.customer
      - text: Add a structured lead for {contact} tagged {tagNames}.
        slots:
          contact: requestBody.contact
          tagNames: requestBody.tagNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/intake'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a lead from query-string intake
      effect: write
      questions:
      - Can I post a lead just by putting its fields in a URL query string?
      - How do I capture UTM tracking with a simple GET form submission?
      instructions:
      - text: Create a lead via the query-string intake for {FirstName} {LastName} at {Phone}.
        slots:
          FirstName: query.FirstName
          LastName: query.LastName
          Phone: query.Phone
      - text: Submit a URL intake lead with email {Email} from campaign {UtmCampaign}.
        slots:
          Email: query.Email
          UtmCampaign: query.UtmCampaign
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/intake'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead from a flat intake payload
      effect: write
      questions:
      - How do I send a lead as a flat JSON intake body?
      - Can the intake payload include the price I paid and a TrustedForm URL?
      instructions:
      - text: Post an intake lead for {firstName} {lastName}, phone {phone}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          phone: requestBody.phone
      - text: Send a flat intake lead with email {email} and TrustedForm certificate {trustedFormUrl}.
        slots:
          email: requestBody.email
          trustedFormUrl: requestBody.trustedFormUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead
      effect: read
      questions:
      - How do I pull up everything about one lead?
      - What status and source does a specific lead have?
      instructions:
      - text: Show lead {id}.
        slots:
          id: path.id
      - text: Get the contact details and status of lead {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lead's details
      effect: write
      questions:
      - How do I correct a lead's contact information?
      - Can I change a lead's customer details and metadata in one update?
      instructions:
      - text: Update lead {id} with contact details {contact}.
        slots:
          id: path.id
          contact: requestBody.contact
      - text: Save new customer info {customer} on lead {id}.
        slots:
          customer: requestBody.customer
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead
      effect: destructive
      questions:
      - How do I remove a lead so it disappears from my pipeline and inbox?
      - Does deleting a lead erase its stored conversation records?
      instructions:
      - text: Delete lead {id}.
        slots:
          id: path.id
      - text: Remove lead {id} from all my lead views.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/workflow-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a lead's automation workflow status
      effect: read
      questions:
      - Is a lead currently in an active automation run or paused?
      - How far along is a lead's follow-up workflow?
      instructions:
      - text: Get the automation workflow status of lead {id}.
        slots:
          id: path.id
      - text: Check if lead {id} has any active follow-up runs.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a lead
      effect: write
      questions:
      - How do I take a lead out of my active pipeline without losing its history?
      - Can I record a reason when archiving a lead?
      instructions:
      - text: Archive lead {id}.
        slots:
          id: path.id
      - text: Archive lead {id} with reason {reason}.
        slots:
          id: path.id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived lead
      effect: write
      questions:
      - How do I bring an archived lead back into my active pipeline?
      - Can follow-up resume on a lead I archived earlier?
      instructions:
      - text: Unarchive lead {id}.
        slots:
          id: path.id
      - text: Restore archived lead {id} to active.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List my leads
      effect: read
      questions:
      - Which leads are in my pipeline right now?
      - Can I list only leads that have no tags?
      - How do I filter leads to ones matching all of several tags?
      instructions:
      - text: List my leads.
      - text: List leads tagged {tagIds}.
        slots:
          tagIds: query.tagIds
      - text: Search my leads for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/tags'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all tags on a lead
      effect: write
      questions:
      - How do I overwrite a lead's tags with a new set?
      - Can I swap out every label on a lead and create missing tags at the same time?
      instructions:
      - text: Replace the tags on lead {id} with {tagNames}.
        slots:
          id: path.id
          tagNames: requestBody.tagNames
      - text: Set lead {id}'s tags to exactly {tagIds}.
        slots:
          id: path.id
          tagIds: requestBody.tagIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to a lead
      effect: write
      questions:
      - How do I add another tag to a lead while keeping its existing ones?
      - Can tagging a lead create the tag if it doesn't exist yet?
      instructions:
      - text: Add tags {tagNames} to lead {id}.
        slots:
          tagNames: requestBody.tagNames
          id: path.id
      - text: Tag lead {id} with {tagIds} in addition to its current tags.
        slots:
          id: path.id
          tagIds: requestBody.tagIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from a lead
      effect: destructive
      questions:
      - How do I take a single tag off a lead?
      - Will removing one tag affect the lead's other labels?
      instructions:
      - text: Remove tag {tagId} from lead {id}.
        slots:
          tagId: path.tagId
          id: path.id
      - text: Untag lead {id} from {tagId}.
        slots:
          id: path.id
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads/{id}/assignment'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a lead to a team member
      effect: write
      questions:
      - How do I give ownership of a lead to someone on my team?
      - Can I put a lead back into the unassigned pool?
      instructions:
      - text: Assign lead {id} to user {assignedToUserId}.
        slots:
          id: path.id
          assignedToUserId: requestBody.assignedToUserId
      - text: Unassign lead {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'