These instructions will enable you to begin posting leads over into our system. Before beginning, it is important that you have received a Source ID from your account rep. If you haven't received one already, please contact your account rep and request a Source ID. This is the unique ID for your company so we can keep track of what leads you transmit over to our system. If you need any help, please contact webmaster@leadgrab.com.

Instructions for API:

1) POST URL: https://api.leadgrab.com

2) DATA TRANSMISSION METHOD: HTTP POST/GET with urlencoded fields

3) RESPONSE: Plaintext response of SUCCESS or ERROR. Error responses will be accompanied with a reason in the following format: "Error: This is the error." If there are multiple errors, you'll be notified of the first one that we identify. These error responses will be especially helpful in troubleshooting your initial setup.

4) REQUIRED/OPTIONAL FIELDS: The following table describes the required and optional fields, appropriate formats, and examples. Please be sure to urlencode any applicable data.

5) TEST API CALLS: Please make sure the test_lead field is set to 1 per the table below and let us know you are performing tests so we can verify data on our end. Test data will not be syndicated to partners or stored in the system beyond 24 hours. Alternatively, you can use the following test data so the system knows it is a test lead: first_name: john, last_name: smith, zip1: 90210 (the system will recognize this as a test lead even if you didn't specify it as test_lead=1

Example request with all fields (you must enter in the source_id and lead_source):

Example request with only required fields (you must enter in the source_id and lead_source):

API Fields:

Field Name	Description	Type	Limit	Example	Applies To	Required
source_id	Unique company ID	integer	5	12345	Moving/Auto	Yes
first_name	First name of the lead	string	255	John	Moving/Auto	Yes
last_name	Last name of the lead	string	255	Smith	Moving/Auto	No
email	Email of the lead	string	255	test@test.com	Moving/Auto	Yes
phone1	Primary phone # of the lead	integer	10	5554443333	Moving/Auto	Yes
ipaddr	IP Address of the lead at time of capture	string	15	12.34.56.78	Moving/Auto	Yes
captured	Date/time of when the lead was captured	datetime	N/A	YYYY-MM-DD HH:MM:SS	Moving/Auto	Yes
lead_id	Universal Lead iD for the lead	string	255	MD5 hash	Moving/Auto	No
zip1	Origin zip code	integer	5	90210	Moving/Auto	Yes
city1	Origin city	string	255	Beverly Hills	Moving/Auto	No
state1	Origin state	string	2	CA	Moving/Auto	No
country1	Origin country	string	2	US	Moving/Auto	No
zip2	Destination zip code	integer	5	02112	Moving/Auto	Yes
city2	Destination city	string	255	Boston	Moving/Auto	No
state2	Destination state	string	2	MA	Moving/Auto	No
country2	Destination country	string	2	US	Moving/Auto	No
move_date	Expected move date	datetime	N/A	YYYY-MM-DD	Moving/Auto	Yes
move_size	Expected move size	integer	1	0 - Studio 1 - 1 BR 2 - 2 BR ... 6 - Over 5 BRs	Moving	Yes
auto_year	Year of the first vehicle to transport	string	255	2015	Auto	No
auto_make	Make of the first vehicle to transport	string	255	Ford	Auto	No
auto_model	Model of the first vehicle to transport	string	255	F150	Auto	No
sub_id	Partner's unique tracking ID	string	255	ABC123	Moving/Auto	No
lead_source	Source where the lead originated	string	255	domain.com	Moving/Auto	Yes
test_lead	If testing or debugging, please ensure this is set to 1	integer	1	0 - Live, 1 - Test	Moving/Auto	No

Changelog:

• 2025-01-28 - Iframe option removed
• 2018-02-19 - SSL supported for iframe
• 2017-01-31 - Test leads can be recognized by passing specific data independent of test_lead=1
• 2016-06-09 - API created and tested
• 2016-09-04 - Iframe option instructions added

Contact webmaster@leadgrab.com with any questions.