Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Bulk API

3 actions 3 updates phrasing extends openapi/qualified-com-bulk-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 3

$.info
$.paths['/v2/bulk'].post
$.paths['/v2/bulk/{id}'].get

OpenAPI Overlay

Raw ↑
# 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 Bulk API
  version: 1.0.0
extends: openapi/qualified-com-bulk-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: 2
- target: $.paths['/v2/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of writes as a bulk job
      effect: write
      questions:
      - How do I push hundreds of record updates to Qualified in one asynchronous batch?
      - What is the maximum number of items a single bulk job can carry?
      - Can I send many lead and company writes together instead of one call each?
      instructions:
      - text: 'Submit a bulk job with these operations: {items}.'
        slots:
          items: requestBody.items
      - text: Queue {items} as one asynchronous bulk write and give me the job id.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/bulk/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk job's status and results
      effect: read
      questions:
      - Has my bulk job finished processing yet?
      - Which items in a submitted batch failed, and why?
      - How long are finished bulk job results kept before they disappear?
      instructions:
      - text: Check the status of bulk job {id}.
        slots:
          id: path.id
      - text: Show the failed items and their errors for bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'