Skip to content

Creates an enrichment query

POST
/v1/enrichments

Creates a new enrichment query that runs on the Surfe cascade, and returns the query ID. The enrichment will run asynchronously, in order to check the status of the results, send a request to GET /v1/enrichments/:id

Authorizations

Request Body

Body

object
enrichmentType
required
string
Allowed values: email emailAndMobile
person
required
object
companyName
string
companyWebsite
string
firstName
string
lastName
string
linkedinUrl
string

Responses

202

Response

object
id
string

400

Request malformed or attributes sent are not enough to enrich a contact, please refer to the documentation

object
code
integer
message
string

401

Missing or wrong API key

object
code
integer
message
string

403

Only paid users may use the public API, please contact support if you need help

object
code
integer
message
string

500

Failed to process request, please try again or contact customer support if you need help

object
code
integer
message
string