Leads
You can use the API to get or set lead information.

The Lead Model

Our Lead API is a central place to gather all information and take actions on your contacts (leads), such as fetching, searching, creating, updating, and deleting.
Key
Type
Description
id
String
The unique identifier for the lead which is given by Tiledesk.
lead_id
String
A unique identifier for the lead which is given to Tiledesk.It's an external id
fullname
String
The lead name and surname.
attributes
Object
The custom attributes which are set for the lead.
createdAt
String
The time (ISO-8601 date string) when the lead was created.
updatedAt
String
The time (ISO-8601 date string) when the lead was updated.
createdBy
String
The unique identifier of the row creator
id_project
String
The unique identifier of the project
get
https://api.tiledesk.com
/v2/:project_id/leads
Get all leads
Example
curl -v -X GET -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/leads
get
https://api.tiledesk.com
/v2/:project_id/leads/:id
Get a lead by id
Example
curl -v -X GET -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/leads/5c81593adf767b0017d1aa66
post
https://api.tiledesk.com
/v2/:project_id/leads
Create a new lead
Example:
curl -v -X POST -H 'Content-Type: application/json' -u [email protected]:123456 -d '{"fullanem":"andrea", "lead_id":"123456"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/leads
put
https://api.tiledesk.com
/v2/:project_id/leads/:id
Update a lead by id
Example:
curl -v -X PUT -H 'Content-Type: application/json' -u [email protected]:123456 -d '{"fullanem":"andrea", "lead_id":"123456"}' https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/leads/5c81593adf767b0017d1aa66
delete
https://api.tiledesk.com
/v2/:project_id/leads/:id
Delete a lead by id
Example:
curl -v -X DELETE -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v2/5b55e806c93dde00143163dd/leads/5c81593adf767b0017d1aa66
Last modified 1yr ago