Developer Hub

getlead

Topics

Create lead API Documentation

This documentation provides a guide on how to use the create lead API, which allows you to assign a import a new lead via any source using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-website-contacts
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
name string The customer name. No
email string The customer email. No
countrycode string Country code like (91). Yes
mobileno string The customer mobile number with or without country code acceptable. Yes
feedback string Customer feedback note can be add. No
source string Source of the lead. Yes
company_name string The customer company name. No
staff_name string The lead will be assign to agent name. No
date_of_birth string The customer dob No
purpose string The lead purpose No
status string The lead status No
department string replace with the department(Staff auto assign option on the basis of department vise) No
{Additional fields} string Create new additional field or update value to existing data No
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-website-contacts?token=gl_8ee******&name=Te***&countrycode=91&mobileno=985*******&source=Test
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
                        {
                        "status": "success",
                        "message": "Lead Added Successfully."
                        }
Error Response
                        1.To check the mobile is valid
                        {
                        "status": "fail",
                        "message": "The mobileno must be between 8 and 14 digits."
                        }
                        2.To check the parameters is valid
                        {
                        "status": "fail",
                        "message": "Please check the parameters."
                        }
Support

If you have any questions or require assistance, please contact our support team at [email protected].

Create Task API Documentation

This documentation provides a guide on how to use the create a new task, which allows you to create a new task to CRM using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-task-creation-api
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
name string To identify the task. Yes
description string Brief description about new task. No
countrycode string To identify which lead under the task. No
mobile_no string To identify which lead under the task No
email string To identify which lead under the task. No
comment string Comments. No
task_category_id string Which category (1:Normal task,2:call task). No
scheduled_date string The date which the task scheduled. No
assigned_to string The assigned_to to which the agent should be assigned. No
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-task-creation-api?token=gl_8ee******&name=Te***&task_category_id=1&assigned_to=Ajay
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
{
                     "status": "success",
                     "message": "Task Added Successfully."
                     }
Error Response
                     {
                     "status": "error",
                     "message": "Please check the parameters."
                     }
Support

If you have any questions or require assistance, please contact our support team at [email protected].

Create Note API Documentation

This documentation provides a guide on how to use the create a note, which allows you to create a note to lead using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-note-creation-api
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
note string To create a new note Yes
countrycode string To identify which lead under the note. Yes
mobile_no string To identify which lead under the note Yes
email string To identify which lead under the note. No
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-note-creation-api?token=gl_8e*****&countrycode=91&mobile_no=98959***56¬e=Te***
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
{
                     "status": "success",
                     "message": "Note Added Successfully."
                     }
Error Response
                     Invalid lead details passed
                     {
                     "status": "error",
                     "message": "Enquiry Not Found."
                     }
                     Invalid parameters passed
                     {
                     "status": "error",
                     "message": "Please check the parameters."
                     }
Support

If you have any questions or require assistance, please contact our support team at [email protected].

Status change API Documentation

This documentation provides a guide on how to change the status of the lead using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-status-change-api
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
status string To identify the status of the lead Yes
countrycode string To identify which lead under the note. Yes
mobile_no string To identify which lead under the note Yes
email string To identify which lead under the note. No
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-status-change-api?token=gl_8e*****&countrycode=91&mobile_no=98959***56&status=Te***
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
{
                     "status": "success",
                     "message": "Note Added Successfully."
                     }
Error Response
                     Invalid lead details passed
                     {
                     "status": "error",
                     "message": "Enquiry Not Found."
                     }
                     Invalid parameters passed
                     {
                     "status": "error",
                     "message": "Please check the parameters."
                     }
Support

If you have any questions or require assistance, please contact our support team at [email protected].

Create Deal API Documentation

This documentation provides a guide on how to use the create a new deal, which allows you to create a new deal to CRM using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-deal-creation-api
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
mobile string To identify which lead under the deal Yes
status string To identify deal status. Yes
deal name string To identify the deal name. No
countrycode string country code. No
staff_name string Deal agent. No
deal_amount integer Deal amount. No
start_date string Deal start estimated time.(format:YYYY-MM-DDD) No
end_date string Deal end estimated time.(format:YYYY-MM-DDD) No
deal_note string Deal note No
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-task-creation-api?token=gl_8ee******&name=Te***&task_category_id=1&assigned_to=Ajay
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
{
                     "status": "success",
                     "message": "Task Added Successfully."
                     }
Error Response
                     {
                     "status": "error",
                     "message": "Please check the parameters."
                     }
Support

If you have any questions or require assistance, please contact our support team at [email protected].

Assign to Department API Documentation

This documentation provides a guide on how to use the Assign to Department API, which allows you to assign a source number to a specific department using the POST method.

API Endpoint
https://app.getlead.co.uk/api/gl-department-vise-agent-assign/{token}
Request Method

POST

Request Parameters
Parameter Type Description Required
token string The token in which we got from the getlead. Yes
SourceNumber string The source number to be assigned. Yes
department string The department to which the source number should be assigned. Yes
To get token
  1. Click on your profile dropdown and then click Settings
  2. In the Getlead setting menu, click GL Connect.
  3. Then Click on the API menu.
  4. In the API page, click Show / generate token button
  5. Copy the token from the popup
  6. Paste the API Parementer accordingly.
Example Request
https://app.getlead.co.uk/api/gl-department-vise-agent-assign/gl_a9a5ed112f********?SourceNumber=4234*******&department=******
Response Format

The API will return a JSON object containing the status of the assignment and a message.

Success Response
{
                     "status": "success",
                     "message": "The source number has been assigned to the specified department."
                     }
Error Response
                     {
                     "status": "error",
                     "message": "Error description (e.g., missing parameters, invalid department, etc.)."
                     }
Support

If you have any questions or require assistance, please contact our support team at [email protected].