Leads & CRM

Manage leads & CRM
Lead Overview
get
​
‎https://<domain>/<api prefix>/<version>/leads/overview/
This API endpoint will return lead summary and appointments.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Query Parameters
appointment
optional
string
Possible values are: upcoming, today, week, and month.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "LeadsData": {
            "status": [
                {
                    "status": <status>,
                    "count": <count>,
                    "Description": "<short_description>",
                    "Color": "<color>"
                },
                ...
            ],
            "source": [
                {
                    "source": <source>
                    "count": <count>
                },
                ...
            ]
        },
        "TotalLeads": <total_leads_count>,
        "appointments": [
            {
                "appointment_note": "<appointment_note>",
                "appointment_status": "<appointment_status>",
                "appointment_date": "<appointment_date>",
                "appointment_to": "<appointment_to>"
            }
        ]
    }
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/leads/overview/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/leads/overview/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Error Responses
Status Code
Error Type
Field
Description
400
Validation Error
appointment
Invalid appointment filter value.
List Leads
get
​
‎https://<domain>/<api prefix>/<version>/leads/list/
This API endpoint will return a list of owned leads. Use the same URL to get a list of assigned leads with a query parameter list_type as 'assigned'. 
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Query Parameters
campaign_slug
optional
string
Get the list of leads under a campaign.
offset
optional
string
​
limit
optional
string
​
list_type
optional
string
Possible value is 'assigned' 
first_name
optional
string
first name
last_name
optional
string
last name
email
optional
string
email address
phone
optional
string
phone number
status
optional
string
lead status, possible values are prospect, tentative, potential, closed, contact, and customer.
owner
optional
string
owner username
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "results": [
            {
                "id": <lead_id>,
                "slug": "<lead_slug>",
                "first_name": "<first_name>",
                "last_name": "<last_name>",
                "name": "<full_name>",
                "phone": "<phone_number>",
                "email": "<email_address>",
                "added_on": "<created_date>",
                "status": "<lead_status>",
                "source": "<lead_source>",
                "owner": "<owner_name>"
            }
            ...
        ],
        "count": <list_count>,
        "previous": <previous_page_url>,
        "next": <next_page_url>
    }
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/leads/list/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/leads/list/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
List Appointments
get
​
‎https://<domain>/<api prefix>/<version>/leads/appointments/list/
This API endpoint will return a list of appointments.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Query Parameters
offset
optional
string
​
limit
optional
string
​
datesetting
optional
string
Possible values are on, before, and after.
ondate
optional
string
required when datesettigs is given, Formate: MM/DD/YYYY
status
optional
string
Possible values are pending, rescheduled, cancelled, 
 fullfilled, and confirmed.    
lead
optional
string
lead firstname
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "results": [
            {
                "id": <appointment_id>,
                "lead_id": <lead_id>,
                "lead": "<lead_name>",
                "leadslug": "<lead_slug>",
                "leadstatus": "<lead_status>",
                "fromdate": "<from_date>",
                "appointment_note": "<appointment_note>",
                "appointment_status": "<appointment_status>",
                "todate": "<to_date>"
            }
            ...
        ],
        "count": <list_count>,
        "previous": <previous_page_url>,
        "next": <next_page_url>
    }
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/appointments/list/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/appointments/list/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Lead Details
get
​
‎https://<domain>/<api prefix>/<version>/leads/view/lead/
This API endpoint will return details of a lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Query Parameters
slug
required
string
Lead slug.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "id": <lead_id>,
        "slug": "<lead_slug>",
        "first_name": "<first_name>",
        "name": "<name>",
        "last_name": "<last_name>",
        "phone": "<phone_number>",
        "email": "<email_address>",
        "status": "<lead_status>",
        "source": "<lead_source>",
        "message": "<lead_message>",
        "added_on": "<created_date>",
        "recent_activities": [
            {
                "id": <activity_id>,
                "activity_type": "<activity_type>",
                "created": "<activity_added_date>",
                "activity": "<activity>"
            },
            ...
        ],
        "notes": [
            {
                "id": <note_id>,
                "note": "<note>",
                "note_created": "<note_created_date>",
                "user": "<note_created_user>"
            }
            ...
        ],
        "conversion": <conversion_percentage>
    }
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/view/lead/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/view/lead/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>',
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Error Responses
Status Code
Error Type
Field
Description
400
Validation Error
slug
This field is required and this may not be blank.
Requested slug is invalid.
Create Appointment
post
​
‎https://<domain>/<api prefix>/<version>/leads/create/appointment/
This API endpoint will create an appointment in a lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Body Parameters
slug
required
string
Lead slug
appointment_date
required
string
Appointment date, format: yyyy-mm-dd hh:mm
appointment_to
required
string
Appointment to date, format: yyyy-mm-dd hh:mm
appointment_note
optional
string
Appointment note. default value is "Prospect appointment''.
appointment_status
optional
string
Appointment status, possible values are pending, rescheduled, cancelled, fullfilled, and, confirmed.
default value is pending.
Response
200: OK
​HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/create/appointment/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'slug': '<lead_slug>',
    'appointment_date': '<yyyy-mm-dd HH:MM>',
    'appointment_note': '<appointment_note>',
    'appointment_status': '<appointment_status>',
    'appointment_to': '<yyyy-mm-dd HH:MM>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/create/appointment/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('slug' => '<lead_slug>','appointment_date' => '<yyyy-mm-dd HH:MM>','appointment_note' => '<appointment_note>','appointment_status' => '<appointment_status>','appointment_to' => '<yyyy-mm-dd HH:MM>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Error Responses
Status Code  
Error Type
Field
Description
401
Request Failed
​
Body data not found.
Appointment schedule exists for this time.
End Date Can't be prior to Start Date.
Please Specify a date in the future.
400
Validation Error
slug
This field is required.
This field is may not be blank.
Requested slug is invalid.
You can't take appointment under this lead.
400
Validation Error
appointment_date
This field is required.
This field is may not be blank.
Invalid date format.
400
Validation Error
appointment_to
This field is required.
This field is may not be blank.
Invalid date format.
400
Validation Error
appointment_note
Ensure this field has no more than 200 characters.
400
Validation Error
appointment_status
Invalid appointment status.
Update Appointment
post
​
‎https://<domain>/<api prefix>/<version>/leads/update/appointment/
This API endpoint will update an appointment.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authrization
required
string
Bearer access token
Query Parameters
appointment_id
required
string
Id of appointment.
slug
optional
string
Lead slug.
appointment_date
optional
string
Appointment date, format: yyyy-mm-dd hh-mm
appointment_note
optional
string
mmappointment_note
appointment_to
optional
string
Appointment to date, format: yyyy-mm-dd hh-mm
appointment_status
optional
string
Appointment status, possible values are pending, rescheduled, cancelled, fullfilled, and, confirmed. default value is pending.
Response
200: OK
​HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/update/appointment/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'appointment_id': '<appointment_id>'
    'slug': '<lead_slug>',
    'appointment_date': '<appointment_date>',
    'appointment_note': '<appointment_note>',
    'appointment_status': '<appointment_status>',
    'appointment_to': '<appointment_to>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/update/appointment/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('slug' => '<lead_slug>','appointment_date' => '<appointment_date>','appointment_note' => '<appointment_note>','appointment_status' => '<appointment_status>','appointment_to' => '<appointment_to>','appointment_id' => '<appointment_id>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Error Responses
Status Code  
Error Type
Field
Description
401
Request Failed
​
Body data not found.
Appointment schedule exists for this time.
End Date Can't be prior to Start Date.
Please Specify a date in the future.
You can't update this appointment.
400
Validation Error
appointment_id
This field is required.
This field is may not be blank.
Invalid appointment id.
Requested appointment not found.
​
400
Validation Error
slug
This field is may not be blank.
Requested slug is invalid.
You can't take appointment under this lead.
400
Validation Error
appointment_date
This field is may not be blank.
Invalid date format.
400
Validation Error
appointment_to
This field is may not be blank.
Invalid date format.
400
Validation Error
appointment_note
Ensure this field has no more than 200 characters.
400
Validation Error
appointment_status
Invalid appointment status.
Delete Appointment
post
​
‎https://<domain>/<api prefix>/<version>/leads/delete/appointment/
This API endpoint will delete an appointment.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token.
Body Parameters
appointment_id
required
string
Appointment id
Response
200: OK
​HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/delete/appointment/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'appointment_id': '<appointment id>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/delete/appointment/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('appointment_id' => '<appointment id>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Error Responses
Status Code  
Error Type
Field
Description
401
Request Failed
​
You can't delete this appointment.
400
Validation Error
appointment_id
This field is required.
This field is may not be blank.
Invalid appointment id.
Requested appointment not found.
​
Create Lead
post
​
‎https://<domain>/<api prefix>/<version>/v1/leads/create/lead/
This API endpoint will create a lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer token
Body Parameters
first_name
required
string
First name.
last_name
required
string
Last name.
email
required
string
Email address
status
optional
string
Lead status, possible values are prospect, tentative, potential, closed, contact, and customer.
source
optional
string
Lead source, possible values are direct, website, facebook, twitter, instagram, search, pinterest, reddit and, other.
phone
required
string
Phone number.
location
optional
string
Location
message
optional
string
Lead message.
assignee
optional
string
Assignee username.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/v1/create/lead/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'first_name': '<first_name>',
    'last_name': '<last_name>',
    'email': '<email>',
    'status': '<status>',
    'source': '<source>',
    'phone': '<phone>',
    'location': '<location>',
    'message': '<message>',
    'assignee': '<assignee_username>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/v1/create/lead/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('first_name' => '<first_name>','last_name' => '<last_name>','email' => '<email>','status' => '<status>','source' => '<source>','phone' => '<phone>','location' => '<location>','message' => '<message>','assignee' => '<assignee>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Error Response
Status Code  
Error Type
Field
Description
400
Validation Error
first_name
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
400
Validation Error
last_name
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
400
Validation Error
email
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
Invalid email.
400
Validation Error
phone
This field is required.
This field may not be blank.
Phone number must be entered in the format: '999999999'. Up to 15 digits allowed.
400
Validation Error
location
Ensure this field has no more than 255 characters.
400
Validation Error
message
Ensure this field has no more than 255 characters.
400
Validation Error
status
<status> is not a valid choice.
400
Validation Error
source
<source> is not a valid choice.
400
Validation Error
assignee
This field may not be blank.
Assignee not found.
Update Lead
post
​
‎https://<domain>/<api prefix>/<version>/leads/update/lead/
This API endpoint will update a lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Beare access token.
Body Parameters
slug
required
string
Lead slug
first_name
required
string
First name.- existing or new
last_name
required
string
Last name.- existing or new
email
required
string
Email address.- existing or new
status
optional
string
Lead status, possible values are prospect, tentative, potential, closed, contact, and customer.
source
optional
string
Lead source, possible values are direct, website, facebook, twitter, instagram, search, pinterest, reddit and, other.
phone
required
string
Phone number.- existing or new.
location
optional
string
Location
message
optional
string
Message
assignee
optional
string
Assignee username.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/update/lead/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'first_name': '<first_name>',
    'last_name': '<last_name>',
    'email': '<email>',
    'status': '<status>',
    'source': '<source>',
    'phone': '<phone>',
    'location': '<location>',
    'message': '<message>',
    'slug': '<lead_slug>',
    'assignee': '<assignee_username>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/update/lead/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('first_name' => '<first_name>','last_name' => '<last_name>','email' => '<email>','status' => '<status>','source' => '<source>','phone' => '<phone>','location' => '<location>','message' => '<message>','slug' => '<lead_slug>','assignee' => '<assignee_username>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Error Responses
Status Code  
Error Type
Field
Description
400
Validation Error
slug
This field is required.
This field may not be blank.
Ensure this field has no more than 258 characters.
400
Validation Error
first_name
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
400
Validation Error
last_name
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
400
Validation Error
email
This field is required.
This field may not be blank.
Ensure this field has no more than 255 characters.
Invalid email.
400
Validation Error
phone
This field is required.
This field may not be blank.
Phone number must be entered in the format: '999999999'. Up to 15 digits allowed.
400
Validation Error
location
Ensure this field has no more than 255 characters.
400
Validation Error
message
Ensure this field has no more than 255 characters.
400
Validation Error
status
<status> is not a valid choice.
400
Validation Error
source
<source> is not a valid choice.
400
Validation Error
assignee
This field may not be blank.
Assignee not found.
401
Request Failed
​
Requested lead does not esixt.
You are not owner of this lead.
Delete Lead
post
​
‎https://<domain>/<api prefix>/<version>/leads/delete/lead/
This API endpoint will delete a lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Body Parameters
slug
required
string
Lead slug
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/delete/lead/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'slug': '<lead_slug>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/delete/lead/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('slug' => 'binuser1'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Error Responses
Status Code  
Error Type
Field
Description
400
Validation Error
slug
This field is required.
This field may not be blank.
Requested lead not found.
Requested lead already has a deleted status.
401
Request Failed
​
You can't delete this lead.
Create Lead Note
post
​
‎https://<domain>/<api prefix>/<version>/leads/create/leadnote/
This API endpoint will create a note on lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Body Parameters
note
required
string
Lead note.
slug
required
string
Lead slug
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/create/leadnote/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'slug': '<lead_slug>',
    'note': '<note>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/create/leadnote/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('slug' => '<lead_slug>','note' => '<note>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Error Responses
Status Code  
Error Type
Field
Description
400
Validation Error
slug
This field is required.
This field may not be blank.
Requested lead not found.
Requested lead already has a deleted status.
400
Validation Error
note
This field is required.
This field may not be blank.
Ensure this field has no more than 499 characters.
401
Request Failed
​
You can't add note on this lead.
Delete Lead Note
post
​
‎https://<domain>/<api prefix>/<version>/leads/delete/leadnote/
This API endpoint will delete a note of lead.
Request
Response
Request
Headers
apikey
required
string
Apikey
Authorization
required
string
Bearer access token
Body Parameters
note_id
required
string
Note id
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {}
}
Sample Code
Node
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://<domain>/<api prefix>/<version>/delete/leadnote/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {
    'note_id': '<note_id>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/delete/leadnote/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('note_id' => '<nit_id>'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access-token>'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
Error Responses
Status Code  
Error Type
Field
Description
400
Validation Error
note_id
This field is required.
This field may not be blank.
Requested note not found.
Invalid note id.
401
Request Failed
​
You can't delete this note.
​
​
​
​
​
​
​
FAQ
Cart
Last updated 3 months ago
Status Code	Error Type	Field	Description
400	Validation Error	appointment	Invalid appointment filter value.
Status Code	Error Type	Field	Description
400	Validation Error	first_name	This field is required. This field may not be blank. Ensure this field has no more than 255 characters.
400	Validation Error	last_name	This field is required. This field may not be blank. Ensure this field has no more than 255 characters.
400	Validation Error	email	This field is required. This field may not be blank. Ensure this field has no more than 255 characters. Invalid email.
400	Validation Error	phone	This field is required. This field may not be blank. Phone number must be entered in the format: '999999999'. Up to 15 digits allowed.
400	Validation Error	location	Ensure this field has no more than 255 characters.
400	Validation Error	message	Ensure this field has no more than 255 characters.
400	Validation Error	status	<status> is not a valid choice.
400	Validation Error	source	<source> is not a valid choice.
400	Validation Error	assignee	This field may not be blank. Assignee not found.
Leads & CRM

Lead Overview

get​

Sample Code

Error Responses

List Leads

get​

Sample Code

List Appointments

get​

Sample Code

Lead Details

get​

Sample Code

Error Responses

Create Appointment

post​

Sample Code

Error Responses

Update Appointment

post​

Sample Code

Error Responses

Delete Appointment

post​

Sample Code

Error Responses

Create Lead

post​

Sample Code

Error Response

Update Lead

post​

Sample Code

Error Responses

Delete Lead

post​

Sample Code

Error Responses

Create Lead Note

post​

Sample Code

Error Responses

Delete Lead Note

post​

Sample Code

Error Responses

get

get

get

get

post

post

post

post

post

post

post

post
