Enrichment API
Bulk Company Enrichment Submission
Perform a bulk search for multiple companies using criteria such as company name, company website. The API supports filtering based on available company data, such as company website and company names. Additionally, you can pass custom metadata using custom fields. Note: At least one combination of company_website or company_name is required.
Request
POST
/companies
companiesarrayrequiredin body
company_namestring
The name of the company where the person works.
Max Length:
255
Example:
ExampleCorp
company_websitestring
The website of the company associated with the person.
Example:
https://example.com
custom_fieldsobjectrequired
An object containing the original fields passed by the user in the initial request. This ensures that users can cross-reference the enriched data with their original input.
Example:
{"website":"example.com","name":"ExampleCorp"}
metadataobjectin body
top_matches_returnednumber
The number of top matching companies to return in the response.
Can be set between 1 and 10 to retrieve multiple company records based on the search criteria.
Default:
1
Maximum: 10
Minimum: 1
Example:
1
Response
200
400
401
403
429
Bulk Company Enrichment Success data.
download_urlstringrequired
A URL link where you can download the results of the bulk company enrichment job once processing is complete. This link will become available after the job is finished.
Example:
https://api.selling.com/companies/results/77f3a5bb-c06f-4caa-ac88-f844ab0ec173.json
expiration_datestringrequired
The Unix Timestamp representing the date and time until which the results of the bulk company enrichment job will be accessible for download. After this time, the results will no longer be available.
Example:
2220091200
job_idstringrequired
A unique identifier for the background process handling the bulk contact enrichment request. Use this ID to track and access the results.
Example:
77f3a5bb-c06f-4caa-ac88-f844ab0ec173
Request Sample
curl -X POST "https://api.selling.com/companies" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"companies": [
{
"company_name": "ExampleCorp",
"company_website": "https://example.com",
"custom_fields": {
"website": "example.com",
"name": "ExampleCorp"
}
}
],
"metadata": {
"top_matches_returned": 1
}
}'
Response Sample
{
"job_id": "77f3a5bb-c06f-4caa-ac88-f844ab0ec173",
"download_url": "https://api.selling.com/companies/results/77f3a5bb-c06f-4caa-ac88-f844ab0ec173.json",
"expiration_date": 2220091200
}