Enrich a lead
Queues the enrichment of one lead: its LinkedIn profile data, email address, phone number, or any combination.
Name the lead by lead_uuid, or by linkedin_profile_url; a URL that matches no lead in the workspace creates one first.
Exactly one of the two must be given.
Everything that would make the enrichment fail is checked before anything is queued: the lead must have a LinkedIn profile URL, at least one requested option must still be missing on the lead (an option already present, or that a previous enrichment could not find, is skipped and reported), no enrichment may already be pending for the lead, and the workspace must have enough credits. A request that fails a check queues nothing and says why, returning the lead where one was resolved.
Enrichment spends credits: 1 for an email, 10 for a phone number, 0.25 for profile data on its own. The credits are reserved when the enrichment is dispatched and settled when it completes; what is not found is released. An agency-managed workspace spends from its agency’s pool, and which key you use decides whether it may. An agency key, calling on a linked workspace, may always spend the pool. The workspace’s own key may spend it only where the agency has enabled direct spending for that workspace, and then only within the monthly cap the agency set for it; without that, the request is refused and nothing is queued. A workspace billed independently spends its own credits, where neither setting applies.
The response does not wait for the enrichment. It returns 202 once the request is queued; the enriched fields appear on the lead when the supplier answers, usually within minutes.
Path Parameters
Body
- Option 1
- Option 2
Exactly one of lead_uuid and linkedin_profile_url must be given.

