Contact

All endpoints related to contacts / people data.

Create Contact

POST https://api.yourdomain.com/v1/contact/create

Create a new contact

Request Body

Name	Type	Description
userId	string	Id of the user creating the contact record
contact	object	JSON object with the field names and the field values

200 Contact created successfully

{
    "success": true,
    "contact": {
                "id": "contact001",
                "firstName": "John",
                "lastName": "Doe",
    }
    link: "https://app.yourdomain.com/contacts/contact001"
}

The contact property in the response should contain the id, first name and last name of the newly created contact.

The link property in the response should contain a link to the newly created record in your backend / CRM application, if applicable.

Update Contact

POST htpps://api.yourdomain.com/v1/contact/update

Update a contact

Request Body

Name	Type	Description
userId	string	Id of the user updating the contact record
id	string	Id of the contact to update
contact	object	JSON object with the field names and the field values

200 Contact updated successfully

{
    "success": true,
    "contact": {
                "id": "contact001",
                "firstName": "John",
                "lastName": "Doe",
                }
}

The contact property in the response should contain the id, first name and last name of the newly created contact.

The link property in the response should contain a link to the newly created record in your backend / CRM application, if applicable.

Search Contact

POST https://api.yourdomain.com/v1/contact/search

Search for a contact

Query Parameters

Name	Type	Description
linkedIn	string	LinkedIn profile URL of the contact we're searching
name	string	Full name of the contact we're searching

200 Search completed successfully

{
    "success": true,
    "contacts": [{
                "id": "contact001",
                "firstName": "John",
                "lastName": "Doe",
              }]
}

In the request, the linkedIn parameter or the name parameter will always be passed (always 1 of the 2).

The contacts property in the response should be an array of results, also if there is only one result. Each result should contain all available fields.