Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Leads API

5 actions 5 updates phrasing extends openapi/qualified-com-leads-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Qualified's API. It is a proposal applied on top of the contract, not a document Qualified publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v2/leads'].get

$.paths['/v2/leads'].post

$.paths['/v2/leads/fields'].get

$.paths['/v2/leads/{id}'].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 Qualified Enterprise Leads API
  version: 1.0.0
extends: openapi/qualified-com-leads-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v2/leads'].get
  update:
    x-apievangelist-phrasing:
      intent: List known leads
      effect: read
      questions:
      - How do I pull all leads that are new or changed since yesterday?
      - Can I find a lead by their email address?
      - Why don't anonymous visitors show up in my list of leads?
      instructions:
      - text: List leads updated since {updated_after}.
        slots:
          updated_after: query.updated_after
      - text: Look up the lead with email {email}.
        slots:
          email: query.email
      - text: List leads created between {created_after} and {created_before}.
        slots:
          created_after: query.created_after
          created_before: query.created_before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/leads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a lead by email
      effect: write
      questions:
      - How do I add a new lead or update an existing one in Qualified?
      - If I upsert a lead, are the custom fields I leave out cleared?
      instructions:
      - text: Create or update the lead {email}.
        slots:
          email: requestBody.email
      - text: Set fields {fields} on the lead with email {email}.
        slots:
          fields: requestBody.fields
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/leads/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom lead field definitions
      effect: read
      questions:
      - Which person-level custom fields exist on leads?
      - How do I map lead field API names to their data types?
      instructions:
      - text: List all custom field definitions for leads.
      - text: Show me the person-category lead field API names and types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/leads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one lead by id
      effect: read
      questions:
      - Can I retrieve a single lead's record using its lead id?
      - How do I get a lead's full details from the leadId on an email?
      instructions:
      - text: Get lead {id}.
        slots:
          id: path.id
      - text: Show the full record and custom fields for lead {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'