enrichment

Enrich people by LinkedIn URL or full name + company or Lead Ids. Maximum 100 allowed

Changed on
post/v1/enrich/contact

Request

Request body

linkedin_urlstring[]

LinkedIn profile URLs to enrich (max 100)

lead_idnumber[]

Lead IDs to enrich (max 100)

reveal_phoneboolean

Whether to reveal phone numbers

profile_onlyboolean

Save profile data only (name, job title, company, location, LinkedIn) with no contact lookup, at a reduced credit cost. Mutually exclusive with email_type and reveal_phone: true — sending either alongside it is rejected.

email_type'work_email' | 'personal_email'

Type of email to reveal. Combined with reveal_phone to decide what is revealed: work_email + reveal_phone=false reveals the work email; work_email + reveal_phone=true reveals work email and phone; personal_email + reveal_phone=false reveals the personal email; personal_email + reveal_phone=true reveals work email, personal email and phone. Ignored — and rejected — when profile_only is true.

webhook_urlstring

Webhook URL to call when enrichment completes

Example request

{
  "linkedin_url": [
    "https://linkedin.com/in/johndoe"
  ],
  "lead_id": [
    12345,
    67890
  ],
  "full_name_with_company": [
    {
      "company_domain": "acme.com",
      "company_website": "https://acme.com"
    }
  ]
}

Response

Enrichment job created. Returns a requestId to track progress.

messagestring

Example response

{
  "message": "Success",
  "payload": {
    "requestId": "64f1a2b3c4d5e6f7a8b9c0d1"
  }
}

Changes