Skip to main content
POST
/
v1
/
contact
curl --request POST \
  --url https://openapi.enginy.ai/v1/contact \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "Ada",
  "lastName": "Lovelace",
  "company": {
    "name": "Analytical Engines",
    "domain": "analytical-engines.com"
  },
  "mergeWithExisting": true
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "professionalEmail": "<string>",
    "linkedinProfileUrl": "<string>",
    "companyId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "contactOutcome": "CREATED",
    "companyOutcome": "NONE",
    "warnings": [
      "<string>"
    ],
    "contactMatchedBy": "LINKEDIN_URL",
    "companyMatchedBy": "LINKEDIN_URL"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
firstName
string

First name of the contact

​
lastName
string

Last name of the contact

​
professionalEmail
string<email>

Professional email address of the contact

​
jobTitle
string

Job title of the contact

​
linkedInProfileUrl
string<uri>

LinkedIn profile URL of the contact

​
mobilePhone
string

Mobile phone number of the contact

​
phones
string

Other phone numbers (comma-separated)

​
linkedInHeadline
string

LinkedIn headline

​
contactCountry
string

Country of the contact

​
company
object

Company information to associate with the contact

​
companyName
string

Alias for company.name when creating or matching the associated company

​
companyDomain
string

Alias for company.domain when creating or matching the associated company

​
companyLinkedInUrl
string<uri>

Alias for company.companyLinkedInUrl when creating or matching the associated company

​
companyIndustry
string

Alias for company.industry

​
companyWebsite
string<uri>

Alias for company.website

​
listId
integer

ID of the list to add the contact to

​
mergeWithExisting
boolean
default:true

Whether to merge with an existing contact or company. Contact matches use normalized LinkedIn profile URL, or exact first name + last name + company name. Company matches use normalized LinkedIn URL, domain, website, or exact name. Defaults to true.

​
{key}
any

Response

Contact created successfully

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
data
object
required