API Specifications
URLs
URL HTTP Post
- Test:https://viberant.leadportal.com/new_api/api.php?Test_Lead=1
- Live:https://viberant.leadportal.com/new_api/api.php
Tracking Fields
- Key– API key
- SRC– ID
- Landing_Page– site URL where lead was generated
- TYPE– special field provided from our system (use the same value in the table below)
Leadtype: Home Improvement – Common fields
Ping Required | Post Required | Field name | Values | Example |
NO | NO | Format | string (format for response – JSON or XML), default XML | JSON |
YES | YES | API_Action | name of the API function to call | pingPostLead |
YES | YES | Key | Vendor API Key | *** |
YES | YES | SRC | Vendor SRC | test |
YES | YES | Mode | ping for ping request full for direct post | ping |
YES | YES | Source | Lead Source | |
YES | YES | Vertical | windows for windows leads roofs for roofs leads bathrooms for bathroom leads hvac for HVAC gutters for Gutters remodel for remodeling | windows |
NO | YES | Lead_ID | Lead ID number received in response of “ping” mode. | 1234 |
YES | NO | Return_Best_Price | 1 | 1 |
YES | YES | TYPE | 33 | 33 |
NO | NO | Test_Lead | 1 (Only when testing) | 1 |
YES | YES | IP_Address | Varchar (100) | 75.2.92.149 |
YES | YES | Landing_Page | Site where lead form completed | landing |
NO | NO | User_Agent | Varchar (500) | User_Agent |
YES | YES | TCPA_Consent | Set. Allowed values: | Yes |
NO | NO | TCPA_Language | Varchar (1000) | TCPA_Language |
NO | NO | LeadiD_Token | Journaya token | LeadiD_Token |
NO | NO | Trusted_Form_URL | Varchar (100) | Trusted_Form_URL |
NO | YES | First_Name | Varchar (100) | John |
NO | YES | Last_Name | Varchar (100) | Doe |
NO | YES | Address | Varchar (100) | 123 Main St. |
YES | YES | Zip | Valid Zip. 5 digits | 60610 |
NO | YES | City | Varchar (100) | Chicago |
YES | YES | State | Valid US state abbreviation. Varchar (2) | IL |
NO | YES | Primary_Phone | Valid phone. 10 digits | 3125552057 |
NO | YES | Valid email. Varchar (100) | ||
YES | YES | Homeowner | Set. Allowed values: | Yes |
YES | YES | Project | Appliances Cleaning Commercial Deck/Fence Replace Electrical Repair Flooring Hardwood Replace Flooring Other Replace Gutter Repair Home Addition Landscaping Large Project Painting Interior Plumbing Replace Remodel Other Roofing Slate Roofing Repair Security Services Windows Repair Cabinets Install Cleaning Residential Doors Electrical Replace Flooring Laminate Replace Flooring Repair Gutter Replace HVAC Repair Landscaping Small Project Pest Control Remodel Bathroom Roofing Metal Roofing Tile Siding Repair Solar Windows Replace – Multiple Cabinets Repair Deck/Fence Repair Driveway Flooring Carpet Replace Flooring Tile Replace Garage Door Handyman HVAC Replace Painting Exterior Plumbing Repair Remodel Kitchen Roofing Shingle Roofing Other Siding Replace Swimming Pool Install Windows Replace – Single |
|
YES | YES | Best_Call_Time | Set. Allowed values: | Morning |
YES | YES | Timeframe | Set. Allowed values: | Immediately |
Home Improvement – Windows related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | Category_Windows | Set. Allowed values: | Windows Install – Single |
YES | YES | Project_Type_Windows | Set. Allowed values: | Replace |
YES | YES | Windows_Number | Set. Allowed values: | 1 |
YES | YES | Windows_Material | Set. Allowed values: | Aluminum |
Home Improvement – Roofs related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | Category_Roofs | Roof Install – Asphalt Shingle Roof Install – Natural Slate Roof Repair – Asphalt Shingle Roof Repair – Tile Roof Install – Flat/SinglePly Roof Install – Tile Roof Repair – Metal Roof Repair – Wood Shake/Comp Roof Install – Metal Roof Install – Wood Shake/Comp Roof Repair – Natural Slate Roof Repair – Flat/SinglePly | Roof Install – Asphalt Shingle |
YES | YES | Project_Type_Roofs | Set. Allowed values: | New Home |
YES | YES | Roof_Job | Set. Allowed values: | Roof Install |
YES | YES | Roof_Material | Set. Allowed values: | Asphalt Shingle |
Home Improvement – Bathrooms related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | Category_Bathroom | Set. Allowed values: | Bathroom Remodel – Bathtub to Shower Conversion |
YES | YES | Project_Type_Bathroom | Full Remodel Bathwraps Cabinets Vanity Countertops Flooring Shower Bath Sinks Toilet Walk In Tub Bathtub Liner Other | Full Remodel |
YES | YES | Remove_Walls | Set. Allowed values: | Yes |
Home Improvement – HVAC related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | HVAC | Boiler Install Boiler Repair/Service Ductless (mini-split) A/C Install Electric Furnace – Repair Gas Furnace – Install Heat Pump Repair HVAC Ducts/Vents – Install/Replace Propane Furnace – Install Swamp Cooler Repair Services Boiler Install/Replace Central A/C – Install/Replace Ductless (mini-split) A/C Service or Repair Electrical Baseboard/Wall Heater – Install Gas Furnace – Repair Humidifier/Dehumidifier – Install Oil Furnace – Install Propane Furnace – Repair Thermostat – Install/Replace Boiler Repair Central A/C – Repair/Service Electric Furnace – Install Electrical Baseboard/Wall Heater – Repair Heat Pump Install Humidifier/Dehumidifier – Repair Oil Furnace – Repair Swamp Cooler Install or Replace
| Boiler Install |
YES | YES | System_Type_HVAC | Central AC Gas boiler Propane boiler Oil boiler Electric boiler Heat pump Water heater Gas furnace Propane furnace Oil furnace Electric furnace
| Central AC |
YES | YES | Air_Type_HVAC | Set. Allowed values: | Cooling |
YES | YES | Project_Type_HVAC | Set. Allowed values: | New unit installed |
Home Improvement – Gutters related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | Gutters | Set. Allowed values: Copper Gutters – Repair Galvanized Gutters – Install Galvanized Gutters – Repair Gutter Cleaning Install or Replace Gutter Covers and Accessories PVC Gutters – Install PVC Gutters – Repair Seamless Metal Gutters – Install Seamless Metal Gutters – Repair Wood Gutters – Install Wood Gutters – Repair | Install or Replace Gutter Covers and Accessories |
Home Improvement – Remodeling related fields:
Ping Required | Post Required | Field name | Values | Example |
YES | YES | Remodeling | Set. Allowed values: Basement Remodel Bathroom Remodel Garage Build Garage Remodel General Contractors Home Addition Kitchen Remodel Major Renovation – Multiple Rooms Remodel or Renovate 1+ Rooms Remodel to Accommodate a Disability | Install or Replace Gutter Covers and Accessories |
HTTP Examples
Ping – https://viberant.leadportal.com/new_api/api.php?Mode=ping
Key | *** |
API_Action | pingPostLead |
Return_Best_Price | 1 |
TYPE | 33 |
IP_Address | 75.2.92.149 |
SRC | test |
Zip | 60610 |
Homeowner | Yes |
Project | Appliances |
Post – https://viberant.leadportal.com/new_api/api.php?Mode=post
Key | *** |
API_Action | pingPostLead |
Lead_ID | 1234 |
TYPE | 33 |
IP_Address | 75.2.92.149 |
SRC | test |
Landing_Page | landing |
First_Name | John |
Last_Name | Doe |
City | Chicago |
State | IL |
Zip | 60610 |
Primary_Phone | 3125552057 |
Homeowner | Yes |
Project | Appliances |
Response Matched Example
JSON
{
“response”: {
“status”: “Matched”,
“lead_id”: “874”,
“price”: “25”
}
}
Response Unmatched Example
JSON
{
“response”: {
“status”: “Unmatched”,
“lead_id”: “874”
}
}
Name | Description | Note |
status | Status |
|
lead_id | ID number of successfully submitted lead | Returned on success |
price | The best price at which a lead can be accepted. | Returned on success and only if Return_Best_Price was submitted in “ping” |
Response – error
JSON
{
“response”: {
“status”: “Error”,
“error”: “Required value First_Name is missing”
}
}
Name | Description | Note |
error | Error message | Returned on error |
status | Status |
|
*** Note
- on City, State, and Zip: Our system will attempt to convert a zip code to city and state if those fields are not sent. If the zip code is not valid though, the system will reject the lead (assuming any one of those three fields are required).
***