Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Companies API

3 actions 3 updates phrasing extends openapi/qualified-com-companies-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/companies'].post
$.paths['/v2/companies/fields'].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 Companies API
  version: 1.0.0
extends: openapi/qualified-com-companies-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/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a company by domain
      effect: write
      questions:
      - How do I set account-level values like tier or owner for a whole company domain in Qualified?
      - If I update a company, do all leads on that domain pick up the new values?
      - Can I rename a company that already exists by sending its domain?
      instructions:
      - text: Create or update the company for domain {domain} named {name}.
        slots:
          domain: requestBody.domain
          name: requestBody.name
      - text: Set account fields {fields} on the company at {domain}.
        slots:
          fields: requestBody.fields
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/companies/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom company field definitions
      effect: read
      questions:
      - Which account-level custom fields can I set on a company?
      - What are the API names and types of the company fields?
      instructions:
      - text: List all custom field definitions for companies.
      - text: Show me the account-category field API names I can write on a company.
      method: generated
      generated: '2026-10-01'