Contacts

List contact

• Endpoint:

GET /contacts

• Allowed for:

Everyone

• Filters:

Name	Type	Comment
name	string	Name of the contact
email	string	Email of the contact
phone	string	Phone of the contact
or	string	Array of filters for or operator

• JSON request data example:

• By name or phone: /contacts?filters[or][name]=Foo&filters[or][phone]=12345

• By name and email or phone: /contacts?filters[name]=illusion&filters[or][email]=test@mycrm&filters[or][phone]=12345

Create contact

• Endpoint:

POST /contacts/{type}

type is linkedin_person, linkedin_company, external_person or external_company.

• Allowed for:

Everyone

• JSON request data

In order to create a LinkedIn person contact, please send the following payload under the contact key:

Name	Type	Mandatory	Comment
linkedin_id	int	yes	LinkedIn Id
first_name	string	yes	Contact first name
last_name	string	yes	Contact last name
headline	string	no	Contact headline title
email	string	no	Contact email address
profile_url	string	no	Contact profile url
profile_picture	string	no	Contact profile pic

In order to create a LinkedIn company contact, please send the following payload under the contact key:

Name	Type	Mandatory	Comment
linkedin_id	int	yes	LinkedIn Id
name	string	yes	Contact company name

In order to create a external person contact, please send the following payload under the contact key:

Name	Type	Mandatory	Comment
first_name	string	yes (one among first_name or last_name)	First name
last_name	string	yes (one among first_name or last_name)	Last name
company	string	no	Company
email	string	yes (one among email or mobile)	Email address
mobile	string	yes (one among email or mobile)	Linkedin profile url
address	string	no	Address
licence	string	no	Licence number

In order to create a external company contact, please send the following payload under the contact key:

Name	Type	Mandatory	Comment
name	string	yes	Company name
email	string	yes (one among email or mobile)	Email
phone	string	yes (one among email or mobile)	Phone number (mobile or landline)
address	string	no	Address
rera	string	no	Rera licence number

• JSON request example:

{
  "contact": {
        "linkedin_id": "3Af70Thj",
        "first_name": "Alain",
        "last_name": "B",
        "head_line": "Foo",
        "profile_url": "http:\/\/bar.com"
    }
}

• JSON response example:

{
    "contact": {
        "id": 3,
        "linkedin_id": "3Af70Thj",
        "first_name": "Alain",
        "last_name": "B",
        "head_line": "Foo",
        "profile_url": "http:\/\/bar.com"
    }
}

Update contact

• Endpoint:

PUT /contacts/{type}/{id}

• Allowed for:

Everyone

• JSON request data

Same than POST request.