EnrichEmail

View as Markdown
## Creates an email-enrichment job for a single lead. Enrichment runs asynchronously - poll `enrich-email/check-job/{jobId}` with the returned `jobId` until the job reaches a terminal status. Provide exactly one of `profileUrl` or `leadMemberId`. ### Body Parameters - **profileUrl** _(string, optional)_: The LinkedIn profile URL of the lead to enrich. If no lead with this URL exists yet, one is created automatically. Cannot be combined with `leadMemberId`. - **leadMemberId** _(string, optional)_: The LinkedIn member id of an existing lead to enrich. Cannot be combined with `profileUrl`. The lead must already exist in the system. ### Response fields - **jobId** _(long)_: Id of the created enrichment job. Pass this to `enrich-email/check-job/{jobId}` to poll for the result. ### Errors All of the following return **400** with body `{ "errorMessage": "..." }`: - Neither `profileUrl` nor `leadMemberId` provided: `One of the following parameters must be provided: profileUrl or leadMemberId.` - Both `profileUrl` and `leadMemberId` provided: `Only one of the following parameters should be provided: profileUrl or leadMemberId.` - `profileUrl` is not a valid LinkedIn profile URL: `The provided URL is not a valid ProfileUrl: <url>` Returns **404** with body `{ "errorMessage": "..." }` when `leadMemberId` is provided but no lead with that id exists: `Lead with id <leadMemberId> does not exist.`

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}

Request

This endpoint expects an object.
profileUrlstringRequiredformat: "uri"
leadMemberIdany or nullOptional

Response

OK
jobIdinteger