Surfe API
Get API KeySupportGive feedback

(Deprecated) Enrich People (bulk) (start)

Deprecated endpoint

This endpoint is deprecated. Please use the latest version here for improved functionality and support.

Quota limitation

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

Starts bulk enriching the provided list of people 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}.

POST
/v1/people/enrichments/bulk

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

People to enrich

enrichmentTypeRequiredstring

Type of enrichment to execute

Value in: "email" | "mobile" | "emailAndMobile" | "noOp"
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"
}