Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Enrich API

3 actions 3 updates phrasing extends openapi/lusha-enrich-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lusha's API. It is a proposal applied on top of the contract, not a document Lusha publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v3/contacts/enrich'].post
$.paths['/v3/companies/enrich'].post

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 Lusha API Documentation Enrich API
  version: 1.0.0
extends: openapi/lusha-enrich-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: 2
- target: $.paths['/v3/contacts/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Reveal emails and phones for found contacts
      effect: write
      questions:
      - How do I unlock the email and phone number for contacts I already searched?
      - Can I reveal only phone numbers and skip emails?
      - Can enrichment fall back to other data providers when there is no match?
      instructions:
      - text: Reveal full data for contacts {ids}.
        slots:
          ids: requestBody.ids
      - text: Reveal only {reveal} for contacts {ids}.
        slots:
          reveal: requestBody.reveal
          ids: requestBody.ids
      - text: Enrich contacts {ids} with waterfall turned on and save them to table {tableId}.
        slots:
          ids: requestBody.ids
          tableId: requestBody.tableId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Reveal full firmographics for found companies
      effect: write
      questions:
      - How do I get revenue, funding and technologies for companies I already searched?
      - How many companies can I enrich in one request?
      - Am I charged for companies that come back without a result?
      instructions:
      - text: Reveal full company data for companies {ids}.
        slots:
          ids: requestBody.ids
      - text: Enrich companies {ids} and add them to table {tableId}.
        slots:
          ids: requestBody.ids
          tableId: requestBody.tableId
      method: generated
      generated: '2026-09-26'