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
| Field | Type | Description | Required |
|---|---|---|---|
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 |
mobilePhone | string | The mobile phone of the contact to enrich. | ❌ No |
Required Fields
One of the following is required to match to a contact:
- firstName, lastName, title, companyName
- firstName, lastName AND (companyDomain OR companySocialUrl)
- personalEmail
- 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 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":"At least one of FirstName, LastName, Email, or MobilePhone is required for social URL enrichment"
}
}
Request
Responses
- 200
Successful response