-
POST /lead-lists/
with a list of LinkedIn URLs that will be processed and revealed -
In the response, follow the URL provided in
response._links.self.href
-
Continue polling the endpoint while respecting the
Retry-After
HTTP Header -
When validation completes, the results are in
response.results
-
If the results are larger than the default limit, then follow the URL provided in
response._links.next.href
Lead List Object
Field | Type | Description |
---|---|---|
id | string | The ID of the Lead List |
name | string | The name of the Lead List |
status | string | The status of the Lead List: |
queued : The validation operation hasn’t started yet | ||
processing : The validation operation is in-progress | ||
completed : The validation operation terminated successfully | ||
canceled : The validation operation terminated due to being canceled | ||
shared | boolean | If the Lead List is shared across the Account |
visible | boolean | If the Lead List is visible in the Dashboard |
owner | string | The email of the owner of the Lead List |
options | object | Options for the Lead List: |
reveal_phone_numbers : boolean - If phone numbers should be revealed for the leads | ||
validate_email : boolean - If the emails of the leads should be validated | ||
enrich : boolean - If the leads should be enriched | ||
type | string | The type of the Lead List: |
linkedin : The inputs were LinkedIn URLs | ||
email : The inputs were emails | ||
title_and_company : The inputs were titles and company names | ||
name_and_company : The inputs were person names and company names | ||
salesforce : The inputs were Salesforce Object IDs | ||
hubspot : The inputs were Hubspot Object IDs | ||
person : The inputs were Person IDs | ||
adaptive : The input CSV file’s columns were used dynamically during enrichment | ||
leads | array of lead_list_entry | The entries of the Lead List; the default number of results that appear is up to 100 |
_links | array of links | Contains useful links related to this resource |
Lead List Entry Object
Field | Type | Description |
---|---|---|
id | string | The ID of the entry |
email | string | The email address of the entry |
person_id | string | The ID of the Person matched with this entry |
linkedin_url | string | The LinkedIn URL of the entry |
first_name | string | The first name of the entry |
last_name | string | The last name of the entry |
company_name | string | The company name of the entry |
company_domain | string | The company domain of the entry |
industry | string | The industry of the entry |
title | string | The title of the entry |
email_validation_result | object of type email_validation_result | The result of the email validation if one occurred |
data | object | Other arbitrary fields may be included here |
Lead List Endpoints
Creating a new Lead List
Request A list of leads can be supplied to create a new Lead List with a subset of settings that are included within thelead_list
object:
-
owner
(string, mandatory) - email of the owner of the lead list which must be an existing user; if a revoked users is provided, the fallback will be the oldest admin’s account instead -
shared
(boolean, mandatory) - indicates whether this list should be shared across the account or just for the specific user -
type
(string, mandatory) - currently onlylinkedin
,email
, andtitles_and_company
are supported -
leads
(array oflead_list_entry
, mandatory) where:-
For the
linkedin
type, each entry only requires the fieldlinkedin_url
-
For the
email
type, each entry only requires the fieldemail
-
For the
titles_and_company
type, each entry only requires the fieldstitle
andcompany_name
(orcompany_domain
)
-
For the
-
name
(string, optional) - defaults to an automatically generated one when not supplied -
visible
(boolean, optional) - defaults to true -
options
(object)-
reveal_phone_numbers
(boolean) - if phone numbers should be revealed for the leads -
validate_email
(boolean) - if the emails of the leads should be validated- Can only be disabled for lists of type
email
- Can only be disabled for lists of type
-
enrich
(boolean) - if the leads should be enriched- Can only be disabled for lists of type
email
- Can only be disabled for lists of type
-
202 Accepted
indicating that the email validation will soon be started:
Location
:GET
points back to the object that was created
self
-GET
points back to the object that was created
Polling a Lead List
Request The Lead List object can be polled in order to receive results:200 OK
while the operation hasn’t yet terminated.
Retry-After
- indicates how long to wait until performing anotherGET
request
self
-GET
points back to the same object
Retrieving a Lead List
Request When the processing of the lead list has terminated, the results can be retrieved using the same url:response._links.next.href
(e.g. GET /lead-lists/81f63c2e-edbd-4c1a-9168-542ede3ce98f?page[size]=100&page[after]=81f63c2e-edbd-4c1a-9168-542ede3ce98a
).
Links
-
self
-GET
points back to the same object -
next
-GET
points to the next page of entries, when available -
prev
-GET
points to the previous page of entries, when available
List Lead Lists
Request Retrieve a list of Lead Lists:200 OK
with a list of Lead Lists:
Add Leads
Request You can also append leads to a Lead List using the ID of the Lead List and the leads you want to add. You can add up to10,000
leads at a time. However, each Lead List can have a maximum of 20,000
leads.
When approaching this limit, new leads will be added partially until the limit is reached. When the limit is hit, a 409
HTTP status code will be returned.
Enriching, email validation, and reveal settings are inherited from the Lead List settings.
If credits are spent, those will be deducted from the admin user of the account.
202 Accepted