Skip to main content
POST
/
v1
/
leads
/
enrich
Start Contacts Enrichment
curl --request POST \
  --url https://api.preceptai.co.uk/v1/leads/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q3 Lead List",
  "webhookUrl": "https://your-site.com/webhook",
  "leads": [
    {
      "linkedinUrl": "https://linkedin.com/in/johndoe",
      "enrichType": [
        "emails",
        "phones"
      ],
      "customData": {
        "contact_id": "lead_123"
      }
    },
    {
      "firstName": "Jane",
      "lastName": "Smith",
      "companyName": "Precept AI",
      "enrichType": [
        "emails"
      ],
      "customData": {
        "contact_id": "lead_456"
      }
    }
  ],
  "includeContactDetails": true
}
'
{
  "message": "Enrichment job successfully created and batches are being processed.",
  "enrichment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.preceptai.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
webhookUrl
string<uri>
required

Your webhook URL to receive the result of the enrichment. If not provided, results are sent to the default webhook configured in your account.

​
leads
object[]
required

An array of lead objects to enrich. Each object must contain either a linkedinUrl or a combination of firstName, lastName, and companyName or companyDomain.

​
name
string

A readable name for your enrichment for searching on your dashboard.

​
includeContactDetails
boolean

Whether to include contact details (email and phone) for the enriched leads. If true, the webhook results will map back these fields as enrichEmail and enrichPhone.

​
translate
boolean

This should be set to true if the lead names are not in English. This is needed for non english names to ensure the most accurate contact details are returned. The names will be translated to English before enriching them.

Response

Request accepted. The enrichment is in progress. The response will vary based on whether all leads could be processed.

​
message
string
Example:

"Enrichment job successfully created and batches are being processed."

​
enrichment_id
string<uuid>