Search Knowledge Base Articles

Lead - Add New Lead [code]

POST

api/leads

Header

Field Type Description
Authtoken String

Basic Access Authentication token.

Parameter

Field Type Description
source String

Mandatory Lead source.
status String

Mandatory Lead Status.
name String

Mandatory Lead Name.
assignedoptional String

Optional Lead assigned.
client_idoptional String

Optional Lead From Customer.
tagsoptional String

Optional Lead tags.
contactoptional String

Optional Lead contact.
titleoptional String

Optional Position.
emailoptional String

Optional Lead Email Address.
websiteoptional String

Optional Lead Website.
phonenumberoptional String

Optional Lead Phone.
companyoptional String

Optional Lead company.
addressoptional String

Optional Lead address.
cityoptional String

Optional Lead City.
stateoptional String

Optional Lead state.
countryoptional String

Optional Lead Country.
default_languageoptional String

Optional Lead Default Language.
descriptionoptional String

Optional Lead description.
custom_contact_dateoptional String

Optional Lead From Customer.
contacted_todayoptional String

Optional Lead Contacted Today.
is_publicoptional String

Optional Lead google sheet id.

 
array (size=20)
   'status' => string '2' (length=1)
   'source' => string '6' (length=1)
   'assigned' => string '1' (length=1)
   'client_id' => string '5' (length=1)
   'tags' => string '' (length=0)
   'name' => string 'Lead Name' (length=9)
   'contact' => string 'Contact A' (length=9)
   'title' => string 'Position A' (length=10)
   'email' => string 'AAA@gmail.com' (length=13)
   'website' => string '' (length=0)
   'phonenumber' => string '123456789' (length=9)
   'company' => string 'Gap Trade' (length=20)
   'address' => string '710-712 Cách Mạng Tháng Tám, P. 5, Q. Tân Bình' (length=33)
   'city' => string 'London' (length=6)
   'state' => string '' (length=0)
   'default_language' => string 'english' (length=10)
   'description' => string 'Description' (length=11)
   'custom_contact_date' => string '' (length=0)
   'is_public' => string 'on' (length=2)
   'contacted_today' => string 'on' (length=2)

Success 200

Field Type Description
status Boolean

Request status.
message String

Lead add successful.

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

Error 4xx

Name Type Description
status Boolean

Request status.
message String

add fail.

 
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Lead add fail."
}

Did you find this article useful?

Related Articles