Leads - Drinkle API Documentation

Get Leads


          GET /lead

Parameter	Default	Description
from	0	From which offset you want to retrieve leads.
to	1000	Upto how many leads do you want to load
search	empty	Search a term in the leads.
sort	date	Sort by: name, date or update.
order	d	Order by: d for descending, a for ascending
id	empty	An id, will find your lead in the query no matter if it is inside the filter or not.

Returns an array of leads in JSON format.


          POST /lead

Parameter	Default	Description
fields	mandatory	Lead values in an key value pair and in JSON format. Eg. {“Name”:”Kapil”,”Stage”:”Commited”,”Phone”:”903943434″}

id and abid(activityboardid) in JSON format. 0 if failed.


          PUT /lead/:id

Parameter

Default

Description

mandatory

Lead ID

fields

mandatory

Lead values in an key value pair and in JSON format.
Eg. {“Name”:”Kapil”,”Stage”:”Commited”,”Phone”:”903943434″}

Note: This should include not only changed fields but also all the unchanged fields too.

Doesn't return anything.


          DELETE /lead/:id

Parameter	Default	Description
id	mandatory	Lead ID

Doesn't return anything.