Enrich Contact

POST 
/v1/enrich/contact

Enrich a LinkedIn profile with contact details from upcell’s database. This endpoint accepts a LinkedIn URL and a list of fields you want to retrieve.

Request Body

Field	Type	Description	Required
linkedinUrl	string	The LinkedIn profile URL of the contact to enrich.	❌ No
firstName	string	The first name of the contact to enrich.	❌ No
lastName	string	The last name of the contact to enrich.	❌ No
title	string	The title of the contact to enrich.	❌ No
companyName	string	The company name of the contact to enrich.	❌ No
companyDomain	string	The company domain of the contact to enrich.	❌ No
companySocialUrl	string	The company social url of the contact to enrich.	❌ No
email	string	The email of the contact to enrich.	❌ No
personalEmail	string	The personal email of the contact to enrich.	❌ No
fields	array	List of fields to enrich (e.g., mobile).	✅ Yes

Possible Field Values

• mobile

---

Required Fields

One of the following is required to match to a contact:

1. firstName, lastName, title, companyName
2. firstName, lastName AND (companyDomain OR companySocialUrl)
3. email
4. personalEmail
5. linkedinUrl

---

Example Request (JSON)

{
  "linkedinUrl": "https://www.linkedin.com/in/marklbedard",
  "fields": ["mobile"]
}

---

Response

The response returns a Contact object with the enriched contact information.

Example Success Response

{
  "contact": {
    "linkedinUrl": "https://www.linkedin.com/in/marklbedard",
    "mobilePhone": "+15550123456"
  }
}

---

Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error Code	Message	Description
400	Invalid Request	Verify your request is properly formatted
401	Unauthorized	Verify you are using a valid API key
500	Internal Server Error	An unexpected error occurred.

Example Error Response

{
  "error": {
    "code": 400,
    "message":"LinkedinUrl is required for data enrichment"
  }
}

Request

Responses

200

Successful response