# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lemlist Enrich API
  version: 1.0.0
extends: openapi/lemlist-enrich-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['/enrich/{enrichId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an enrichment request
      effect: read
      questions:
      - Has my enrichment request finished, and what did it find?
      - Where do I fetch the email or phone an enrichment job returned?
      instructions:
      - text: Get the result of enrichment {enrichId}.
        slots:
          enrichId: path.enrichId
      - text: Check whether enrichment {enrichId} has completed.
        slots:
          enrichId: path.enrichId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a person who isn't a lead
      effect: write
      questions:
      - How do I find a verified email for someone from their name and company domain?
      - Can I enrich a LinkedIn profile without adding it to a campaign?
      - Is there a way to get notified by webhook when enrichment finishes?
      instructions:
      - text: Find the email of {firstName} {lastName} at {companyDomain}, with findEmail set to {findEmail}.
        slots:
          firstName: query.firstName
          lastName: query.lastName
          companyDomain: query.companyDomain
          findEmail: query.findEmail
      - text: Run LinkedIn enrichment ({linkedinEnrichment}) on profile {linkedinUrl}.
        slots:
          linkedinEnrichment: query.linkedinEnrichment
          linkedinUrl: query.linkedinUrl
      - text: Verify the address {email} with verifyEmail {verifyEmail} and post results to {webhookUrl}.
        slots:
          email: query.email
          verifyEmail: query.verifyEmail
          webhookUrl: query.webhookUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/leads/{leadId}/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich an existing campaign lead
      effect: write
      questions:
      - How do I find the phone number for a lead already in my campaign?
      - Can I run LinkedIn enrichment on a lead I've already added?
      instructions:
      - text: Enrich lead {leadId} with findPhone {findPhone}.
        slots:
          leadId: path.leadId
          findPhone: query.findPhone
      - text: Find a verified email for campaign lead {leadId} and notify {webhookUrl}.
        slots:
          leadId: path.leadId
          webhookUrl: query.webhookUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/enrichments/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich many people in one bulk request
      effect: write
      questions:
      - Can I submit a whole batch of people for enrichment at once?
      - What's the way to enrich a list of prospects without one call per person?
      instructions:
      - text: Submit a bulk enrichment for my prospect list.
      - text: Run a bulk enrichment and send the events to {webhookUrl}.
        slots:
          webhookUrl: query.webhookUrl
      method: generated
      generated: '2026-10-01'