Leads
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
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 all leads
GET https://api.tiledesk.com/v3/:project_id/leads
Allows an account to list all the leads.
Path parameters
project_id (string) — the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query parameters
sortField (string) — what field to sort the results by.
direction (string) — sort direction: 1 or -1. Return the results in ascending or descending order. Defaults to desc.
email (string) — search a lead by the email address.
page (number) — what page of results to fetch. Defaults to first page.
Headers
Authorization (string) — Authorization token. Basic Auth or JWT. Minimum role: agent
Success response (200)
Example
Get a lead by id
GET https://api.tiledesk.com/v3/:project_id/leads/:id
Fetches a lead by his or her Lead ID.
Path parameters
id (string) — the lead identifier.
project_id (string) — the project_id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type (string) — use "application/json" value
Success response (200)
Example
Create a new lead
POST https://api.tiledesk.com/v3/:project_id/leads
Allows to add more leads.
Path parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization (string) — Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type (string) — use "application/json" value
Request body
email (string) — the lead email address
lead_id (string) — the external id of the lead
fullname (string) — the lead fullname
attributes (object) — the lead custom attributes
Success response (200)
Example
Update a lead by id
PUT https://api.tiledesk.com/v3/:project_id/leads/:id
Allows to update a lead.
Path parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk.
id (string) — The id is the lead identifier.
Headers
Authorization (string) — Authorization token. Basic Auth or JWT. Minimum role: agent
Content-Type (string) — use "application/json" value
Request body
email (string) — the lead email address
fullname (string) — The lead fullname
attributes (object) — The lead custom attributes
phone (string) — The lead phone
company (string) — The lead company
note (string) — Notes
streetAddress (string) — The lead address
city (string) — The lead city
region (string) — The lead region
zipcode (string) — The lead zipcode
country (string) — The lead country
tags (array) — The lead tags
Success response (200)
Example
Delete a lead by id
DELETE https://api.tiledesk.com/v3/:project_id/leads/:id
Allows to delete a lead.
Path parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk.
id (string) — The id is the lead identifier.
Headers
Authorization (string) — Authorization token. Basic Auth or JWT. Minimum role: agent
Success response (200)
Examples and references
Lead model details: https://developer.tiledesk.com/apis/rest-api/leads#the-lead-model
Get all leads: https://developer.tiledesk.com/apis/rest-api/leads#get-all-leads
Get a lead by id: https://developer.tiledesk.com/apis/rest-api/leads#get-a-lead-by-id
Create a new lead: https://developer.tiledesk.com/apis/rest-api/leads#create-a-new-lead
Update a lead by id: https://developer.tiledesk.com/apis/rest-api/leads#update-a-lead-by-id
Delete a lead by id: https://developer.tiledesk.com/apis/rest-api/leads#delete-a-lead-by-id
Last updated 1 year ago
Was this helpful?