Skip to main content
POST

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
searchResultIds
string[]

Array of search result IDs obtained from a prior /search/contacts call. Each ID triggers a contact research request that consumes one credit. Mutually exclusive with the contacts property.

Maximum array length: 100
Example:
​
isJobChange
boolean
default:false

When set to true, triggers a job change research for the provided contacts. Must be used together with the contacts array; cannot be used with searchResultIds.

Example:

false

​
contacts
object[]

Contact enrich request. Provide an array of contacts to research by identity. Each item must include one of the following combinations:

  • contactName and companyName (optionally include title when using isJobChange)
  • contactName and domain
  • email
  • liProfileUrl
  • liSalesNavUrl
  • liRecruiterUrl

Mutually exclusive with searchResultIds. When isJobChange is true, only the contacts array should be used.

Maximum array length: 100
​
skipDeduplicationCheck
boolean
default:false

When true, research will not check for duplicate records that you already researched recently, and perform a research (which can result in credit usage)

Response

The request IDs for research

​
success
boolean

Indicates whether the research request was accepted successfully.

Example:

true

​
requestIds
string[]

Array of request IDs corresponding to each contact research request. Use these IDs to poll for results via /contacts/research/poll.

Maximum array length: 100
Example: