Enrich Contacts (start)

Quota limitation

This endpoint will not succeed if there is not enough contact enrichment quota or credits available

Starts bulk enriching the provided list of contacts and returns an enrichment ID. The enrichment will run asynchronously, in order to check the enrichment's progress and results, send a request to GET /v1/people/enrichments/bulk/{id}.

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

Contacts to be enriched

enrichmentTypeRequiredstring

Type of enrichment to execute

Value in: "email" | "emailAndMobile"

listNameRequiredstring

Name for the new list that will created to store the results

peopleRequiredarray<object>

List of people to enrich (maximum 10000)

Provide either a linkedinUrl or a combination of "firstName lastName companyName" or combination of "firstName lastName companyWebsite"

curl -X POST "https://api.surfe.com/v1/people/enrichments/bulk" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enrichmentType": "email",
    "listName": "My list name",
    "people": [
      {
        "clientID": "DEPRECATED",
        "companyName": "ACME corp",
        "companyWebsite": "acme.org",
        "externalID": "external-id",
        "firstName": "Jane",
        "lastName": "Doe",
        "linkedinUrl": "https://www.linkedin.com/in/janedoe/"
      }
    ]
  }'

Enrichment ID

{
  "id": "enrichment-id",
  "listName": "My list name"
}

Enrich Contacts (start)

Authorization

Request Body

Response

TypeScript