Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Sources API

8 actions 8 updates phrasing extends openapi/leadping-sources-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 8

$.info

$.paths['/sources'].post

$.paths['/sources/{id}'].get

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

$.paths['/sources/{id}'].delete

$.paths['/sources/{id}/credentials/rotate'].post

$.paths['/sources/all/my'].post

$.paths['/sources/{id}/metrics'].get

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 Sources API
  version: 1.0.0
extends: openapi/leadping-sources-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['/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead intake source
      effect: write
      questions:
      - How do I set up a new lead source for a vendor sending me leads?
      - Can I restrict a source to certain states and products?
      - Is it possible to require a TrustedForm certificate on incoming leads?
      instructions:
      - text: Create a lead source named {name} for states {allowedStates} and products {allowedProducts}.
        slots:
          name: requestBody.name
          allowedStates: requestBody.allowedStates
          allowedProducts: requestBody.allowedProducts
      - text: Add a source accepting {allowedProducts} in {allowedStates}, tagging leads {defaultTagNames}.
        slots:
          allowedProducts: requestBody.allowedProducts
          allowedStates: requestBody.allowedStates
          defaultTagNames: requestBody.defaultTagNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead source
      effect: read
      questions:
      - How do I check the intake settings of one lead source?
      - What routing context is configured on a specific source?
      instructions:
      - text: Show lead source {id}.
        slots:
          id: path.id
      - text: Get the intake settings of source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lead source
      effect: write
      questions:
      - How do I change which states an existing source accepts?
      - Can I update the default tags on a lead source?
      instructions:
      - text: Update source {id} to accept states {allowedStates}.
        slots:
          id: path.id
          allowedStates: requestBody.allowedStates
      - text: Change source {id}'s default tags to {defaultTagNames}.
        slots:
          id: path.id
          defaultTagNames: requestBody.defaultTagNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead source
      effect: destructive
      questions:
      - How do I stop a source from sending me any more leads?
      - Can I remove a lead source entirely?
      instructions:
      - text: Delete lead source {id}.
        slots:
          id: path.id
      - text: Remove source {id} so it can't accept new leads.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/{id}/credentials/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a source's intake credential
      effect: destructive
      questions:
      - How do I rotate the credential a vendor uses to post leads?
      - Will I be able to see the new source secret again later?
      instructions:
      - text: Rotate the intake credential for source {id}.
        slots:
          id: path.id
      - text: Invalidate source {id}'s current secret and issue a new one.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List my lead sources
      effect: read
      questions:
      - Which lead sources are configured for my account?
      - Can I search my intake sources by name?
      instructions:
      - text: List my lead sources.
      - text: Search my lead sources for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/{id}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead source's metrics
      effect: read
      questions:
      - How many leads from a source were accepted, rejected or duplicates?
      - Can I see a source's lead metrics for the past week?
      instructions:
      - text: Show lead metrics for source {id}.
        slots:
          id: path.id
      - text: Get source {id}'s accepted and rejected counts for the last {days} days.
        slots:
          id: path.id
          days: query.days
      method: generated
      generated: '2026-09-26'