GEgenpage
Leads

Enrich existing leads, spending credits to research them.

Changed on

Each type is a separate piece of research, and each costs credits per lead. Ask for only what the pages actually use.

  • linkedin_profile_url — scrape the lead's LinkedIn profile
  • company_domain — AI analysis of the company
  • person_analysis — AI analysis of the person
  • linkedin_posts_person — the person's recent posts
  • linkedin_posts_company — the company page's recent posts

A lead missing the inputs a type needs (no LinkedIn URL, no domain) is skipped rather than failing the batch — compare leads_to_enrich against what you sent, and check skipped_leads. Results land on the leads themselves; poll job_id with get-status, then read them back with get-lead.

post/api/external/v1/leads/enrich

Request

Request body

workspace_idinteger required

The workspace the leads belong to.

lead_idsinteger[] required

Leads to enrich, from search-leads.

enrichment_typesstring[] required

One or more of linkedin_profile_url, company_domain, person_analysis, linkedin_posts_person, linkedin_posts_company.

Example request

{
  "workspace_id": 55,
  "lead_ids": [
    56789,
    56790
  ],
  "enrichment_types": [
    "company_domain"
  ]
}

Response

job_idstring
messagestring
leads_to_enrichinteger
skipped_leadsinteger

Example response

{
  "job_id": "9f1c8b2e-...",
  "message": "Enrichment job started",
  "leads_to_enrich": 2,
  "skipped_leads": 0
}

Changes

  • 29a37db12acbRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

  • dd3f47f72f7aRevision changes
    • info

      endpoint added