Leadspace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadspace API v4 Enrichment API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/enrichment/enrich/single'].post
$.paths['/enrichment/enrich/bulk'].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 Leadspace API v4 Enrichment API
  version: 1.0.0
extends: openapi/leadspace-enrichment-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['/enrichment/enrich/single'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich one person or company record instantly
      effect: read
      questions:
      - How do I enrich a single lead or account and get the data back right away?
      - What fields are required to enrich one person, like first name, last name and email?
      - Can I attach my own ID to a single enrichment so it comes back on the result?
      instructions:
      - text: Enrich person {person} right now and return the matched details.
        slots:
          person: requestBody.person
      - text: Look up firmographics for the single company {company}.
        slots:
          company: requestBody.company
      - text: Enrich contact {person} at {company} synchronously and tag it with my ID {external_id}.
        slots:
          person: requestBody.person
          company: requestBody.company
          external_id: requestBody.external_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/enrichment/enrich/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of records for enrichment
      effect: write
      questions:
      - How do I enrich hundreds of leads at once in Leadspace?
      - What is the maximum number of records allowed in one bulk enrichment request?
      - Can I be notified by callback when a bulk enrichment job is done instead of polling?
      instructions:
      - text: 'Submit these records for bulk enrichment: {data}.'
        slots:
          data: requestBody.data
      - text: Queue bulk enrichment of {data} and notify {callbackUrl} when processing completes.
        slots:
          data: requestBody.data
          callbackUrl: requestBody.callbackUrl
      - text: Start a bulk enrichment job for {data} under my batch reference {external_bulk_id}.
        slots:
          data: requestBody.data
          external_bulk_id: requestBody.external_bulk_id
      method: generated
      generated: '2026-10-01'