Skip to main content

Enrich Social URL

POST 

/v1/enrich/socialurl

Enrich a contact with social URLs based on input data including: mobile phone, email, and name/title/company.

Request Body

FieldTypeDescriptionRequired
firstNamestringThe first name of the contact to enrich.❌ No
lastNamestringThe last name of the contact to enrich.❌ No
titlestringThe title of the contact to enrich.❌ No
companyNamestringThe company name of the contact to enrich.❌ No
companyDomainstringThe company domain of the contact to enrich.❌ No
companySocialUrlstringThe company social url of the contact to enrich.❌ No
emailstringThe email of the contact to enrich.❌ No
personalEmailstringThe personal email of the contact to enrich.❌ No
mobilePhonestringThe mobile phone of the contact to enrich.❌ No

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. mobilePhone

Example Request (JSON)

{
"mobilePhone": "+15555555555"
}


Response

The response returns a list of social profile URLs for the matched contact.

Example Success Response

{
"socialProfiles": [{"network": "LINKEDIN", "url": "https://www.linkedin.com/in/marklbedard"}]}
}


Error Handling

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

Error CodeMessageDescription
400Invalid RequestVerify your request is properly formatted
401UnauthorizedVerify you are using a valid API key
500Internal Server ErrorAn unexpected error occurred.

Example Error Response

{
"error": {
"code": 400,
"message":"At least one of FirstName, LastName, Email, or MobilePhone is required for social URL enrichment"
}
}

Request

Responses

Successful response