[POST] - Asynchronous (batch) Target Contact List Build API

Follow

Use this endpoint to build a list a contacts using rich filters in batch mode.

The elements in the contact list contain a newid value and enough additional information such that a user could narrow down a selection from the list. Using the selected newid values you can retrieve additional contact information through the Target API's New Contact Details endpoint.

Endpoint

POST https://api.insideview.com/api/v1/target/contacts/export/job

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes Valid access token.
See Authentication and Authorization Overview for more details.
Accept String No

Selects the response's content type.  
Valid values are application/json and application/xml (default).

Use below mentioned values to access New News Platform based search

application/api.news.target.contact.beta+json

application/api.news.target.contact.beta+xml

Form Parameters

Parameter Name Type Required Description
agents String No agents ID.
See API Reference data for a list of IDs.
areaCodes Integer No A comma separated list of area codes
businessTypes String No A comma separated list of business types.
Valid values are: public, private, school,government, organization
cities String No A comma separated list of cities
peopleCountries String No Comma separated list of Country Ids
peopleStates String No Comma separated list of States
peopleCities String No Comma separated list of Cities
peopleArea String No Area for the search
peopleAddress String No Address for the search
companyName String No Name of the company
companyIdsToInclude String No List of company Ids or new Ids of companies to restrict the list to
companyIdsToExclude String No List of company Ids or new Ids  to exclude from list
companyStatus String No A comma separated list of status.
Valid values are: operating, subsidiary, acquired
countries Integer No One country ID.
See API Reference data for a list of IDs.
fiscalYearEnd String No Example: january
fortuneRanking String No Valid values are: fortune500, fortune1000
industries String No A comma separated list of industries IDs.
See API Reference data for a list of IDs.
active Boolean No If present returns only active / inactive contacts
isEmailRequired Boolean No If set to true, only contacts with an email address will be counted.
isPhoneRequired Boolean No  If set to true, only contacts with a phone number will be counted.
jobFunctions String No A comma separated list of job function ID.
See API Reference data for a list of IDs. 
jobLevels String No A comma separated list of job level ID.
See API Reference data for a list of IDs. 
fullName String No Contact's full name.
keyword String No Deprecated, see titles parameter
Keyword string that will be matched against titles.
keywords String No Restrict agents results to news containing the keywords passed in parameter. Search news articles, press releases, and SEC filings for up to 30 days. you can use newsDuration field for specific number of days.
newsDuration Integer No A duration in days (1-30).  Works with agents and keywords parameter.
maxEmployees Integer No  
maxRevenue Integer No  
minEmployees Integer No  
minRevenue Integer No  
naics String No

A comma separated list of NAICS codes.
List of NAICS codes.

You can enter NAICS & SIC codes in two different ways:

  • Direct code – for example, enter 511210 for Software Publishers.
  • Top Level codes – for example, enter 511* for All Publishing Industries which would include 51111 – 51119 or even 5112* which would include 511210.
primaryIndustryOnly String No  
primaryNAICSOnly String No  
primarySICOnly String No  
regions String No A comma separated list of regions.
Valid values are: Africa, Asia, Europe, MiddleEast, NorthAmerica, Oceania, SouthAmerica
sic String No  
street String No Street name
state String No Comma separated list of states
subIndustries String No A comma separated list of sub-industries IDs.
See API Reference data for a list of IDs.
titles String No Keyword string that will be matched against titles.
zipCodes String No A comma separated list of zip codes.
page Integer No Default: 1
resultsPerPage Integer No Default: 10, maximum value: 500
sortBy String No Attributes used to sort the list of results. Valid values are: active, title, popularity, companyName
sortOrder String No Valid values are: asc, desc
gender String No Diversity status based on Gender
ethnicity Int No

Diversity status based on Ethnicity. Valid values are comma separated list of ethnicity ids. 

ID Values
1 Asian-Indian
2 Non-Ethnic
3 Asian-Pacific
4 Hispanic
5 African American
6 Native American
7 Asian

 

dbe Boolean No Diversity status based on Disadvantages Business Ent. 
wbe  Boolean No Diversity status based on Women Business Ent. 
mbe  Boolean No Diversity status based on Minority Business Ent. 
vbe  Boolean No Diversity status based on Veteran Business Ent.
disabled  Boolean No Diversity status based on Disabled Business Ent. 
lgbt Boolean No Diversity status based on Gay Lesbian business Ent. 

 

Responses

Here are the major responses the API may return.

for details on the errors, please refer to the API Error Codes article.

HTTP 200

An HTTP 200 status means the data have been accepted and a job have been queued.

application/json example response

{
  jobId: "peerukbkasr85s6hdtb9"
  status: "accepted"
  type: "targetContactSearchAsyncExport"
}

application/xml example response

<?xml version="1.0" encoding="UTF-8"?>
<BulkJobStatus>
 <jobId>a8bpdds1one7vblg0obm</jobId>
 <status>accepted</status>
 <type>targetContactSearchAsyncExport</type>
</BulkJobStatus>

HTTP 400

Invalid query parameter(s).

HTTP 401

Unauthorized Error - Cannot use API's without setting a valid accessToken in header.

HTTP 405

Method Not Allowed - Your are not allowed to access this API.

HTTP 429

Request is throttled.

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk