EnrichEmail
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.
Request
- Base URL: https://api
- URL: https://api//api/public/enrichment/enrich-email
- Auth: none declared
Headers
API key header using this scheme. Example: "X-API-KEY: {API_KEY}"
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.