Skip to main content
POST

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

Body

application/json

Exactly one of lead_uuid and linkedin_profile_url must be given.

lead_uuid
string<uuid>
required

An existing lead in the workspace.

enrichment_options
enum<string>[]
required

What to enrich. An unknown name refuses the request; a repeated one counts once.

Minimum array length: 1
Available options:
linkedin_profile,
email,
phone
linkedin_profile_url
string

A LinkedIn profile URL. Normalised the same way as on lead creation; a URL that matches no lead creates one.

Example:

"https://www.linkedin.com/in/jane-doe"

Response

Enrichment queued. Credits are reserved when the queued job dispatches, not in this request. While this one is pending, another request for the same lead that still has something to enrich is refused with 409.

lead
object
required
Example:
enrichment
object
required