Add New Lead

POST/api/leads

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
source String Mandatory Lead source.
status String Mandatory Lead Status.
name String Mandatory Lead Name.
assigned String Mandatory Lead assigned.
client_id String optional Optional Lead From Customer.
tags String optional Optional Lead tags.
contact String optional Optional Lead contact.
title String optional Optional Position.
email String optional Optional Lead Email Address.
website String optional Optional Lead Website.
phonenumber String optional Optional Lead Phone.
company String optional Optional Lead company.
address String optional Optional Lead address.
city String optional Optional Lead City.
zip String optional Optional Zip code.
state String optional Optional Lead state.
country String optional Optional Lead Country.
default_language String optional Optional Lead Default Language.
description String optional Optional Lead description.
custom_contact_date String optional Optional Lead From Customer.
contacted_today String optional Optional Lead Contacted Today.
is_public String optional Optional Lead google sheet id.
curl -X POST "https://yoursite.com/api/leads" \
  -H "authtoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "source": "...", "status": "...", "name": "...", "assigned": "..." }'

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Lead add successful."
}

Error-Response:

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Lead add fail."
}
MethodPOST
Path/api/leads
GroupLeads
Sincev0.0.0
Defined inmodules/api/controllers/Leads.php