connectleads api instructions (1) (2) (2).pdf
TRANSCRIPT
-
How to use our API for submitting leads to ConnectLeads
Our API for electronically submitting leads really only consists of a simple HTTP request method. You can use either the HTTP POST method or the HTTP GET method. For testing purposes we have created a sandbox. Once you have tested and our web development department has confirmed that we received the data correctly, we will provide you with the live URL to post leads to.
Fields to submit to the APIA page is attached with field types, required fields, and details for each field that the API will accept.
Sandbox for testingFor testing, the URL to POST to is:http s ://connectleads.com/api/post_new_lead_sandbox.php *** Note, there is no www in the URL!! ***
If you choose to use the GET method, then simply append the field names and their corresponding values to the URL like the following example:
https://connectleads.com/api/post_new_lead_sandbox.php?name=john smith&phone1=1234567890&state=RI&office=yourofficename
Upon submitting a lead successfully, you should see a JSON encoded return string like this:{"status":1,"message":"SUCCESS","lead_id":"1"}
An error will return a JSON encoded string like this:{"status":6,"message":"NO_DATA_SUBMITTED"}
When we set your office up in our system, we will also record an email address where all errors should be emailed to. That way in the event any of your leads are rejected you will receive an email with the error code and an explanation.
Field Name Field Type in our DB Required Description/Notes
name Yes Owner first and last name in one field
spouse Spouse first and last name in one field
phone1 Yes Must contain 10 digits
phone2 Must contain 10 digits
address
city
state Yes
zip Must be valid 5 digit format
office Yes
Choices: YES, NO
color color of house
style
pets yes, no
notes text
email
varchar(255)
varchar(200)
bigint(10)
bigint(10)
varchar(25)
varchar(25)
varchar(2)
Choices are AL, CA, CO, CT, FL, GA, KY, MA, MO, NH, NJ, NY, NC, OH, OK, PA, RI, SC, TN, TX, WV
varchar(20)
varchar(25)This is specific to each office/dealer, you will be provided with this info
ownedhome varchar(25)
varchar(25)
varchar(25)style of the house (trailer, single family, brick, ranch, raised ranch, colonial, etc)
varchar(3)
if there is info you want to provide that doesn't have it's own field you can add it in the notes field here
varchar(254)Please supply full email address, including the domain