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
searchResultId
string

A search result ID obtained from a prior /search/contacts call. Provide either searchResultId or contact, not both. Consumes one credit.

Example:

"11ad7a1c-9a63-30e0-a1de-cd9a766805ca"

contact
object

Contact enrich request. Provide either searchResultId or contact, not both. Must include one of the following combinations:

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

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

Example:

false

listIds
integer[]

IDs of the contact lists to add the newly saved contact to. A contact that was already researched is not saved again, so it is not added to the lists. The lists must already belong to the authenticated user; an unknown ID fails the research request, which reports the error when you poll for it.

Maximum array length: 50
Example:
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 ID for research

success
boolean

Indicates whether the research request was accepted successfully.

Example:

true

requestId
string

The request ID for the contact research request. Use it to poll for results via /contacts/research/poll.

Example:

"6Ei5iKuSHzJXvqjVPWiZ_"