Window Docs
Field | Post Required | Ping Required | Detail | Data Type | Values Allowed | Example |
---|---|---|---|---|---|---|
leadtype | Yes | Yes | 3 letter product code | text (3) | win | win |
affid | Yes | Yes | Your affiliate id provided by ABCLeads | number | 1005 | |
firstName | Yes | n/a | First name of lead | text | John | |
lastName | Yes | n/a | Last name of lead | text | Prospect | |
address1 | Yes | n/a | Address line 1 | text | 123 Main Street | |
address2 | No | n/a | Address line 2 | text | Apt 23 | |
city | Yes | n/a | Lead City | text | Providence | |
state | Yes | n/a | Lead State | text | AL AK AZ AR CA CO CT DE DC FL GA HI ID IL IN IA KS KY LA ME MD MA MI MN MS MO MT NE NV NH NJ NM NY NC ND OH OK OR PA RI SC SD TN TX UT VT VA WA WV WI WY |
RI |
zip | Yes | Yes | Lead Zipcode | number | 02901 | |
phone1 | Yes | n/a | Lead phone number | number | 4011234567 | |
phone2 | No | n/a | Lead alternative phone number | number | 4011234567 | |
Yes | n/a | Lead email address | text | something@example.com | ||
bestcall | Optional | Optional | Best time to call | text | morning afternoon evening any time |
morning |
ownproperty | Optional | Optional | Prospect owns property | text | yes no |
yes |
numberofwindows | Yes | Yes | Number of Windows | number | Number | 12 |
whypurchase | Optional | Optional | Reason for the windows | text | heat Convenience cleaning appearance |
heat |
whenpurchase | Optional | Optional | When they plan to purchase | text | Immediately 1 to 3 Months 3 to 6 Months Within a Year Not Sure |
Immediately |
howfinance | Optional | Optional | How they will finance | text | Funds on hand Home equity loan Bank loan Would like to learn about financing options |
Funds on hand |
quotereason | Optional | Optional | Wants assistance with | text | Provide me information on new replacement windows for my home I am in need of service but would also be interested in information on new windows I am in need of services at this time I have a warranty issue with windows that are less than 5 years old |
Provide me information on new replacement windows for my home |
comments | Optional | Optional | Comments | text | ||
window_type | Optional | Optional | Type of Window | text | Bay or Bow Fixed (non-opening) Sliding Glass window Garden window Casement Sliding Glass Door Double Hung (both halves open) French Door Single-Hung (lower half opens) Awning (hinged at the top) Unsure |
Bay or Bow |
window_condition | Optional | Optional | Window Condition | text | Poor Average Good |
Poor |
window_age | Optional | Optional | Window Age | text | New (Less than a Year old) 1 – 5 Years Old 6+ Years old |
New (Less than a Year old) |
tcpa_consent | Yes | Yes | Lead Agreed to TCPA Complience | text | yes no |
yes |
tcpa_language | Yes | Yes | TCPA language they agreed to | text | ||
phone_type | Yes | Yes | Phone Number Type | text | mobile landline unknown |
mobile |
subid | Optional | n/a | Lead identifier | text | LEAD45697 | |
source | Yes | Yes | Your source or channel identifier | text | PPC6547 | |
source_type | Yes | Yes | The type of source that drove this lead | text | Search Organic Search Paid Coreg Banner Link Call Center Piggyback Non-Mobile Site Conquest Unknown Mobile Site Mobile App Other |
Ping
The ping checks if a buyer is available for the lead that you want to sell us. Using Dynamic ping url will display the commission that we will pay you for the lead if you decide to post us the full lead. Static URL uses the agreed upon price as seen inside your affilaite account by product.
Static Ping URL: https://www.abcleads.com/xmlpost/ping.php
Dynamic Ping URL: https://www.abcleads.com/xmlpost/pingxml.php
Example
Request | Response |
<?xml version="1.0" encoding="ISO-8859-1"?> <ping> <affid>1005</affid> <protype>win</protype> <zip>02889</zip> <exclusive>true</exclusive> <source>1234</source> <source_type>Email</source_type> </ping> |
<?xml version="1.0" encoding="ISO-8859-1"?> <ping> <approved>1</approved> <payout>15.23</payout> <pingid>ABC123456789123</pingid> </ping> |
Ping Response
A breakdown of the ping response
Field | Detail |
---|---|
approved | Either a 1 or 0 is returned. 1 means we will accept the lead. 0 means we will not. |
payout | What ABCLeads will set the commission for this lead |
pingid | Ping ID. Needs to be sent on the post in order for the post to be accepted. |
Ping Errors
If an error occurs on the post the response would look similar to this:
Response |
<?xml version="1.0" encoding="ISO-8859-1" ?> <ping> <approved>0</approved> <error>Error Text Here</error> </ping> |
Post
After a successful ping ABCLeads can then accept the posting of the full lead data.
Post URL: http://services.abcleads.com/post
Static Post URL: https://www.abcleads.com/xmlpost/xml.php
Dynamic Post URL: https://www.abcleads.com/xmlpost/postxml.php
Example
Request | Response |
<?xml version="1.0" encoding="ISO-8859-1"?> <Leads> <lead> <leadtype>win</leadtype> <affid>1005</affid> <firstName>John</firstName> <lastName>Prospect</lastName> <address1>123 Main Street</address1> <address2>Apt 23</address2> <city>Providence</city> <state>RI</state> <zip>02901</zip> <phone1>4011234567</phone1> <phone2>4011234567</phone2> <email>something@example.com</email> <bestcall>morning</bestcall> <ownproperty>yes</ownproperty> <numberofwindows>12</numberofwindows> <whypurchase>heat</whypurchase> <whenpurchase>Immediately</whenpurchase> <howfinance>Funds on hand</howfinance> <quotereason>Provide me information on new replacement windows for my home</quotereason> <comments></comments> <window_type>Bay or Bow</window_type> <window_condition>Poor</window_condition> <window_age>New (Less than a Year old)</window_age> <tcpa_consent>yes</tcpa_consent> <tcpa_language></tcpa_language> <phone_type>mobile</phone_type> <subid>LEAD45697</subid> <pingid>ABC50F6FA4220247</pingid> <source>PPC6547</source> <source_type>Email</source_type> </lead> </Leads> |
<?xml version="1.0" encoding="ISO-8859-1" ?> <lead> <leademail>something@example.com</leademail> <approved>1</approved> <lead_id>WIN12345</lead_id> </lead> |
Post Errors
If an error occurs on the post the response would look similar to this:
Response |
<?xml version="1.0" encoding="ISO-8859-1" ?> <lead> <approved>0</approved> <leademail>something@example.com</leademail> <errors><error>Error Text Here</error></errors> </lead> |