Form Fill Leads

Who Uses These Specifications?

Publishers who host and post leads through their own lead routing software
Publishers who collect consent via a TCPA disclaimer

Important Notes

Fields and Enums are case sensitive! Use exact syntax
Fields listed must be included to receive competitive bids.
Do not use the “Test_Lead” field to test.
You must use a 2-step Ping/Post request.
To test for multiple buyers, use Zip=00002.

Required Fields

PING	POST	Field	Value
Yes	Yes	`Key`	Provided
Yes	Yes	`SRC`	Provided
Yes	Yes	`API_Action`	pingPostLead
Yes	Yes	`Mode`	Mode=ping on ping Mode=post on post
Yes	Yes	`TYPE`	33
Yes	Yes	`Task`	ex: Plumbing
Yes	Yes	`Zip`	ex: 90210
Yes	Yes	`Sub_ID`	ex: 123
Yes	Yes	`Pub_ID`	ex: 123
Yes	No	`Return_Best_Price`	1
No	Yes	`Lead_ID`	Provided
No	Yes	`Trusted_Form_URL`	ex: https://cert.trustedform.com/12345
No	Yes	`Disclaimer`	ex: By clicking Get Quote, you affirm that…
No	Yes	`Landing_Page`	ex: https://restoratlon.com/
No	Yes	`User_Agent`	ex: Mozilla/5.0
No	Yes	`IP_Address`	ex: 75.231.71.196
No	Yes	`First_Name`	ex: John
No	Yes	`Last_Name`	ex: Smith
No	Yes	`Address`	ex: 123 Test St
No	Yes	`City`	ex: Chicago
No	Yes	`State`	ex: IL
No	Yes	`Phone`	ex: 123-456-7890
No	Yes	`Email`	ex: test@gmail.com
No	Yes	`Comment`	Recorded by Client
Yes	Yes	`Owner`	No Yes
Yes	Yes	Property_Type	Business Residence
Yes	Yes	Job_Type	Cleaning Install Refinish Repair Resurface Sealing
Yes	Yes	Material	Asphalt Barbed Wire Brick Carpet Chainlink Concrete Copper Electric Pet Epoxy Gravel Laminate Metal Pavers PVC Single Ply Slate Spray Foam Stone Stucco Tar Gravel Tile Vinyl Wood Wrought Iron
No	No	`Format`	JSON, XML, dft:String
No	No	`Unique_Identifier`	Your Unique Lead ID

Task Specific Fields

In order for you to receive competitive bids, we expect you to send specific fields depending on the task. For example, sending the “Job_Type” field tells us whether the Task is expected to be an “Install” or a “Repair”.

To make this process more organized, we’ve included a Google Sheet that includes our Task List and their respective fields to send. To view the most up-to-date enums for our fields, please review this table here.

Testing Conditions

Please send a test ping/post to the test zip code 00001 and inform us when you receive a successful reply. Please email us with the ping and post request and response strings! Once we confirm everything is functioning properly, we can move to live production.

Example PING Request & Response

https://app.inquirly.com/apiJSON.php
{
    "Request": {
        "Key": {YOUR_API_KEY},
        "SRC": {YOUR_SRC},
        "Sub_ID": "123",
        "Mode": "ping",
        "API_Action": "pingPostLead",
        "Return_Best_Price": "1",
        "TYPE": "33",
        "Zip": "00001",
        "Task": "Roofing",
        "Format": "JSON",
        "Unique_Identifier": {YOUR_UNIQUE_IDENTIFIER},
        "Owner": "Yes",
        "Property_Type": "Residence",

        "Job_Type": "Install",
        "Material": "Asphalt",
        "Project_Status": "Ready to Hire",
        "Timing": "Immediate",
    }
}

{
    "response": {
        "status": "Matched",
        "lead_id": "34940707",
        "price": "0.05"
    }
}

Example POST Request & Response

https://app.inquirly.com/apiJSON.php
{
    "Request": {
        "Lead_ID": {NEW_LEAD_ID},
        "Key": {YOUR_API_KEY},
        "SRC": {YOUR_SRC},
        "Sub_ID": "123",
        "Mode": "post",
        "API_Action": "pingPostLead",
        "Return_Best_Price": "1",
        "TYPE": "33",
        "Zip": "00001",
        "Task": "Roofing",

        "User_Agent": "Chrome",
        "Disclaimer": "TCPA Text",
        "Trusted_Form_URL": "URL",
        "Landing_Page": "Landing Page",
        "First_Name": "John",
        "Last_Name": "Smith",
        "Address": "123 Fake Address Dr",
        "City": "Los Angeles",
        "State": "CA",
        "Phone": "1234567890",
        "Email": "test@inquirly.com",
        "IP_Address": "75.2.92.149",
        "Comment": "Test Commment",
        "Owner": "Yes",
        "Property_Type": "Residence",

        "Job_Type": "Install",
        "Material": "Asphalt",
        "Project_Status": "Ready to Hire",
        "Timing": "Immediate",

        "Format": "JSON",
        "Unique_Identifier": {YOUR_UNIQUE_IDENTIFIER}
    }
}

{
    "response": {
        "status": "Success"
    }
}