Leads API

This page includes all endpoints available for the leads module.

The leads API offers the following endpoints:

Add Lead

This endpoint allows you to create a new lead.

Endpoint: /_admin/_api/lead/add-lead.php

Request type: POST

Request Data:

Item	Description	Type
[‘key’]*	Your API Key	(string)
[‘lead’][‘firstname’]*	First Name	(string)
[‘lead’][‘lastname’]*	Last Name	(string)
[‘lead’][’email’]*	Email address	(string)
[‘lead’][‘dob’]	Date of Birth	(date – yyyy/mm/dd)
[‘lead’][‘phone’]	Primary Phone Number	(string)
[‘lead’][‘phone2’]	Secondary Phone Number	(string)
[‘lead’][‘address’]	Street Address	(string)
[‘lead’][‘city’]	City	(string)
[‘lead’][‘state’]	State / Province	(string)
[‘lead’][‘country’]	Country	(string)
[‘lead’][‘zip’]	Zip / Postal Code	(string)
[‘lead’][‘preffered_lang’]	Language Abbreviation [EN,FR,ES]	(string)
[‘lead’][‘message’]	Message from lead	(string)

This endpoint allows you to update / modify the data for an existing lead.

Endpoint: /_admin/_api/lead/edit-lead.php

Request type: POST

Request Data:

Item	Description	Type
[‘key’]*	Your API Key	(string)
[‘lead’][‘firstname’]*	First Name	(string)
[‘lead’][‘lastname’]*	Last Name	(string)
[‘lead’][’email’]*	Email address	(string)
[‘lead’][‘dob’]	Date of Birth	(date – yyyy/mm/dd)
[‘lead’][‘phone’]	Primary Phone Number	(string)
[‘lead’][‘phone2’]	Secondary Phone Number	(string)
[‘lead’][‘address’]	Street Address	(string)
[‘lead’][‘city’]	City	(string)
[‘lead’][‘state’]	State / Province	(string)
[‘lead’][‘country’]	Country	(string)
[‘lead’][‘zip’]	Zip / Postal Code	(string)
[‘lead’][‘preffered_lang’]	Language Abbreviation [EN,FR,ES]	(string)
[‘lead’][‘message’]	Message from lead	(string)

This endpoint allows you to fetch data for an existing lead using the lead’s unique ID.

Endpoint: /_admin/_api/lead/fetch-lead.php

Request type: POST

Request Data: