{"id":11816,"date":"2023-06-01T08:12:05","date_gmt":"2023-06-01T08:12:05","guid":{"rendered":"https:\/\/homerevive.co\/?page_id=11816"},"modified":"2023-06-01T08:13:00","modified_gmt":"2023-06-01T08:13:00","slug":"api-specs","status":"publish","type":"page","link":"https:\/\/homerevive.co\/api-specs\/","title":{"rendered":"API Specs"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-page\" data-elementor-id=\"11816\" class=\"elementor elementor-11816\">\n\t\t\t\t\t\t<section class=\"elementor-section elementor-top-section elementor-element elementor-element-9da518a elementor-section-boxed elementor-section-height-default elementor-section-height-default wd-section-disabled\" data-id=\"9da518a\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-top-column elementor-element elementor-element-8aa6469\" data-id=\"8aa6469\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t<div class=\"elementor-element elementor-element-a546478 color-scheme-inherit text-left elementor-widget elementor-widget-text-editor\" data-id=\"a546478\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<h1>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <strong>API Specifications<\/strong><\/h1><h1>URLs<\/h1><p><strong>URL HTTP Post<\/strong><\/p><ul><li><strong>Test:<\/strong>https:\/\/viberant.leadportal.com\/new_api\/api.php?Test_Lead=1<\/li><li><strong>Live:<\/strong>https:\/\/viberant.leadportal.com\/new_api\/api.php<\/li><\/ul><p>Tracking Fields<\/p><ul><li><strong>Key<\/strong>&#8211; API key<\/li><li><strong>SRC<\/strong>&#8211; ID<\/li><li><strong>Landing_Page<\/strong>&#8211; site URL where lead was generated<\/li><li><strong>TYPE<\/strong>&#8211; special field provided from our system (use the same value in the table below)<\/li><\/ul><p>Leadtype:\u00a0<strong>Home Improvement &#8211; Common fields<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"95\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"95\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"166\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"186\"><p><strong>Values<\/strong><\/p><\/td><td width=\"129\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>Format<\/p><\/td><td width=\"186\"><p>string (format for response &#8211; JSON or XML), default XML<\/p><\/td><td width=\"129\"><p>JSON<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>API_Action<\/p><\/td><td width=\"186\"><p>name of the API function to call<\/p><\/td><td width=\"129\"><p>pingPostLead<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Key<\/p><\/td><td width=\"186\"><p>Vendor API Key<\/p><\/td><td width=\"129\"><p>***<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>SRC<\/p><\/td><td width=\"186\"><p>Vendor SRC<\/p><\/td><td width=\"129\"><p>test<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Mode<\/p><\/td><td width=\"186\"><p>ping\u00a0 for ping request<br \/>post for post request<\/p><p>full for direct post<br \/><br \/><\/p><\/td><td width=\"129\"><p>ping<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Source<\/p><\/td><td width=\"186\"><p>Lead Source<\/p><\/td><td width=\"129\"><p>Facebook<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Vertical<\/p><\/td><td width=\"186\"><p>windows for windows leads<\/p><p>roofs for roofs leads<\/p><p>bathrooms for bathroom leads<\/p><p>hvac for HVAC<\/p><p>gutters for Gutters<\/p><p>remodel for remodeling<\/p><\/td><td width=\"129\"><p>windows<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Lead_ID<\/p><\/td><td width=\"186\"><p>Lead ID number received in response of &#8220;ping&#8221; mode.<\/p><\/td><td width=\"129\"><p>1234<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES\u00a0<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>Return_Best_Price<\/p><\/td><td width=\"186\"><p>1<\/p><\/td><td width=\"129\"><p>1<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>TYPE<\/p><\/td><td width=\"186\"><p>33<\/p><\/td><td width=\"129\"><p>33<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>Test_Lead<\/p><\/td><td width=\"186\"><p>1 (Only when testing)<\/p><\/td><td width=\"129\"><p>1<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>IP_Address<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>75.2.92.149<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Landing_Page<\/p><\/td><td width=\"186\"><p>Site where lead form completed<\/p><\/td><td width=\"129\"><p>landing<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>User_Agent<\/p><\/td><td width=\"186\"><p>Varchar (500)<\/p><\/td><td width=\"129\"><p>User_Agent<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>TCPA_Consent<\/p><\/td><td width=\"186\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Yes<br \/>\u00a0\u00a0\u00a0\u00a0No<\/p><\/td><td width=\"129\"><p>Yes<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>TCPA_Language<\/p><\/td><td width=\"186\"><p>Varchar (1000)<\/p><\/td><td width=\"129\"><p>TCPA_Language<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>LeadiD_Token<\/p><\/td><td width=\"186\"><p>Journaya token<\/p><\/td><td width=\"129\"><p>LeadiD_Token<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"166\"><p>Trusted_Form_URL<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>Trusted_Form_URL<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>First_Name<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>John<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Last_Name<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>Doe<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Address<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>123 Main St.<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Zip<\/p><\/td><td width=\"186\"><p>Valid Zip. 5 digits<\/p><\/td><td width=\"129\"><p>60610<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>City<\/p><\/td><td width=\"186\"><p>Varchar (100)<\/p><\/td><td width=\"129\"><p>Chicago<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>State<\/p><\/td><td width=\"186\"><p>Valid US state abbreviation. Varchar (2)<\/p><\/td><td width=\"129\"><p>IL<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Primary_Phone<\/p><\/td><td width=\"186\"><p>Valid phone. 10 digits<\/p><\/td><td width=\"129\"><p>3125552057<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>NO<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Email<\/p><\/td><td width=\"186\"><p>Valid email. Varchar (100)<\/p><\/td><td width=\"129\"><p>test@nags.us<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Homeowner<\/p><\/td><td width=\"186\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Yes<br \/>\u00a0\u00a0\u00a0\u00a0No<\/p><\/td><td width=\"129\"><p>Yes<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Project<\/p><\/td><td width=\"186\"><p>Appliances<\/p><p>Cleaning Commercial<\/p><p>Deck\/Fence Replace<\/p><p>Electrical Repair<\/p><p>Flooring Hardwood Replace<\/p><p>Flooring Other Replace<\/p><p>Gutter Repair<\/p><p>Home Addition<\/p><p>Landscaping Large Project<\/p><p>Painting Interior<\/p><p>Plumbing Replace<\/p><p>Remodel Other<\/p><p>Roofing Slate<\/p><p>Roofing Repair<\/p><p>Security Services<\/p><p>Windows Repair<\/p><p>Cabinets Install<\/p><p>Cleaning Residential<\/p><p>Doors<\/p><p>Electrical Replace<\/p><p>Flooring Laminate Replace<\/p><p>Flooring Repair<\/p><p>Gutter Replace<\/p><p>HVAC Repair<\/p><p>Landscaping Small Project<\/p><p>Pest Control<\/p><p>Remodel Bathroom<\/p><p>Roofing Metal<\/p><p>Roofing Tile<\/p><p>Siding Repair<\/p><p>Solar<\/p><p>Windows Replace &#8211; Multiple<\/p><p>Cabinets Repair<\/p><p>Deck\/Fence Repair<\/p><p>Driveway<\/p><p>Flooring Carpet Replace<\/p><p>Flooring Tile Replace<\/p><p>Garage Door<\/p><p>Handyman<\/p><p>HVAC Replace<\/p><p>Painting Exterior<\/p><p>Plumbing Repair<\/p><p>Remodel Kitchen<\/p><p>Roofing Shingle<\/p><p>Roofing Other<\/p><p>Siding Replace<\/p><p>Swimming Pool Install<\/p><p>Windows Replace &#8211; Single<\/p><\/td><td width=\"129\"><p>\u00a0<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Best_Call_Time<\/p><\/td><td width=\"186\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Morning<br \/>\u00a0\u00a0\u00a0\u00a0Afternoon<br \/>\u00a0\u00a0\u00a0\u00a0Evening<br \/>\u00a0\u00a0\u00a0\u00a0Anytime<\/p><\/td><td width=\"129\"><p>Morning<\/p><\/td><\/tr><tr><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"95\"><p><strong>YES<\/strong><\/p><\/td><td width=\"166\"><p>Timeframe<\/p><\/td><td width=\"186\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Immediately<br \/>\u00a0\u00a0\u00a0\u00a0Within 1 month<br \/>\u00a0\u00a0\u00a0\u00a01-3 months<br \/>\u00a0\u00a0\u00a0\u00a03+ months<\/p><\/td><td width=\"129\"><p>Immediately<\/p><\/td><\/tr><\/tbody><\/table><p><strong>\u00a0<\/strong><\/p><p><strong>Home Improvement &#8211; Windows related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"169\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"193\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Category_Windows<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Windows Install &#8211; Single<br \/>\u00a0\u00a0\u00a0\u00a0Windows Install &#8211; Multiple<br \/>\u00a0\u00a0\u00a0\u00a0Windows Repair<br \/>\u00a0\u00a0\u00a0\u00a0Windows &#8211; Cleaning<\/p><\/td><td width=\"113\"><p>Windows Install &#8211; Single<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Project_Type_Windows<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Replace<br \/>\u00a0\u00a0\u00a0\u00a0Repair<\/p><\/td><td width=\"113\"><p>Replace<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Windows_Number<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a01<br \/>\u00a0\u00a0\u00a0\u00a02<br \/>\u00a0\u00a0\u00a0\u00a03-5<br \/>\u00a0\u00a0\u00a0\u00a06-9<br \/>\u00a0\u00a0\u00a0\u00a010+<\/p><\/td><td width=\"113\"><p>1<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Windows_Material<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Aluminum<br \/>\u00a0\u00a0\u00a0\u00a0Brick or Stone<br \/>\u00a0\u00a0\u00a0\u00a0Metal<br \/>\u00a0\u00a0\u00a0\u00a0Vinyl<br \/>\u00a0\u00a0\u00a0\u00a0Wood<br \/>\u00a0\u00a0\u00a0\u00a0Not Sure<\/p><\/td><td width=\"113\"><p>Aluminum<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p><strong>Home Improvement &#8211; Roofs related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"169\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"193\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Category_Roofs<\/p><\/td><td width=\"193\"><p>Roof Install &#8211; Asphalt Shingle<\/p><p>Roof Install &#8211; Natural Slate<\/p><p>Roof Repair &#8211; Asphalt Shingle<\/p><p>Roof Repair &#8211; Tile<\/p><p>Roof Install &#8211; Flat\/SinglePly<\/p><p>Roof Install &#8211; Tile<\/p><p>Roof Repair &#8211; Metal<\/p><p>Roof Repair &#8211; Wood Shake\/Comp<\/p><p>Roof Install &#8211; Metal<\/p><p>Roof Install &#8211; Wood Shake\/Comp<\/p><p>Roof Repair &#8211; Natural Slate<\/p><p>Roof Repair &#8211; Flat\/SinglePly<\/p><\/td><td width=\"113\"><p>Roof Install &#8211; Asphalt Shingle<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Project_Type_Roofs<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0New Home<br \/>\u00a0\u00a0\u00a0\u00a0Existing Home<br \/>\u00a0\u00a0\u00a0\u00a0Repair<\/p><\/td><td width=\"113\"><p>New Home<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Roof_Job<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Roof Install<br \/>\u00a0\u00a0\u00a0\u00a0Roof Repair<\/p><\/td><td width=\"113\"><p>Roof Install<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Roof_Material<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Asphalt Shingle<br \/>\u00a0\u00a0\u00a0\u00a0Cedar Shake<br \/>\u00a0\u00a0\u00a0\u00a0Metal<br \/>\u00a0\u00a0\u00a0\u00a0Tar<br \/>\u00a0\u00a0\u00a0\u00a0Tile<br \/>\u00a0\u00a0\u00a0\u00a0Natural Slate<br \/>\u00a0\u00a0\u00a0\u00a0Flat\/SinglePly<br \/>\u00a0\u00a0\u00a0\u00a0Wood Shake\/Comp<\/p><\/td><td width=\"113\"><p>Asphalt Shingle<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p>\u00a0<\/p><p><strong>Home Improvement &#8211; Bathrooms related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"169\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"193\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Category_Bathroom<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Bathroom Remodel &#8211; Bathtub to Shower Conversion<br \/>\u00a0\u00a0\u00a0\u00a0Bathroom Remodel &#8211; Complete Remodel<br \/>\u00a0\u00a0\u00a0\u00a0Bathroom Remodel &#8211; Shower Install or Upgrade<br \/>\u00a0\u00a0\u00a0\u00a0Bathroom Remodel &#8211; Vanity, Fixtures, Sinks, Toilets, Other<br \/>\u00a0\u00a0\u00a0\u00a0Bathroom Remodel &#8211; Walk-In Tub Installation or Conversion<\/p><\/td><td width=\"113\"><p>Bathroom Remodel &#8211; Bathtub to Shower Conversion<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Project_Type_Bathroom<\/p><\/td><td width=\"193\"><p>Full Remodel\u00a0\u00a0\u00a0\u00a0<\/p><p>Bathwraps\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Cabinets Vanity<\/p><p>Countertops\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Flooring\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Shower Bath<\/p><p>Sinks\u00a0\u00a0\u00a0<\/p><p>Toilet\u00a0\u00a0\u00a0<\/p><p>Walk In Tub<\/p><p>Bathtub Liner\u00a0\u00a0\u00a0\u00a0<\/p><p>Other<\/p><\/td><td width=\"113\"><p>Full Remodel<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Remove_Walls<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Yes<br \/>\u00a0\u00a0\u00a0\u00a0No<\/p><\/td><td width=\"113\"><p>Yes<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p><strong>Home Improvement &#8211; HVAC related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"169\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"193\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>HVAC<\/p><\/td><td width=\"193\"><p>Boiler Install<\/p><p>Boiler Repair\/Service<\/p><p>Ductless (mini-split) A\/C Install<\/p><p>Electric Furnace &#8211; Repair<\/p><p>Gas Furnace &#8211; Install<\/p><p>Heat Pump Repair<\/p><p>HVAC Ducts\/Vents &#8211; Install\/Replace<\/p><p>Propane Furnace &#8211; Install<\/p><p>Swamp Cooler Repair Services<\/p><p>Boiler Install\/Replace<\/p><p>Central A\/C &#8211; Install\/Replace<\/p><p>Ductless (mini-split) A\/C Service or Repair<\/p><p>Electrical Baseboard\/Wall Heater &#8211; Install<\/p><p>Gas Furnace &#8211; Repair<\/p><p>Humidifier\/Dehumidifier &#8211; Install<\/p><p>Oil Furnace &#8211; Install<\/p><p>Propane Furnace &#8211; Repair<\/p><p>Thermostat &#8211; Install\/Replace<\/p><p>Boiler Repair<\/p><p>Central A\/C &#8211; Repair\/Service<\/p><p>Electric Furnace &#8211; Install<\/p><p>Electrical Baseboard\/Wall Heater &#8211; Repair<\/p><p>Heat Pump Install<\/p><p>Humidifier\/Dehumidifier &#8211; Repair<\/p><p>Oil Furnace &#8211; Repair<\/p><p>Swamp Cooler Install or Replace<\/p><p>\u00a0<\/p><\/td><td width=\"113\"><p>Boiler Install<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>System_Type_HVAC<\/p><\/td><td width=\"193\"><p>Central AC\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Gas boiler\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Propane boiler<\/p><p>Oil boiler\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Electric boiler\u00a0\u00a0\u00a0<\/p><p>Heat pump<\/p><p>Water heater\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Gas furnace\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Propane furnace<\/p><p>Oil furnace\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>Electric furnace<\/p><p>\u00a0<\/p><\/td><td width=\"113\"><p>Central AC<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Air_Type_HVAC<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Cooling<br \/>\u00a0\u00a0\u00a0\u00a0Heating<br \/>\u00a0\u00a0\u00a0\u00a0Heating and cooling<\/p><\/td><td width=\"113\"><p>Cooling<\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"169\"><p>Project_Type_HVAC<\/p><\/td><td width=\"193\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0New unit installed<br \/>\u00a0\u00a0\u00a0\u00a0Repair<\/p><\/td><td width=\"113\"><p>New unit installed<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p><strong>Home Improvement &#8211; Gutters related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"134\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"228\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"134\"><p>Gutters<\/p><\/td><td width=\"228\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Copper Gutters &#8211; Install<\/p><p>\u00a0\u00a0\u00a0 Copper Gutters &#8211; Repair<\/p><p>\u00a0\u00a0\u00a0 Galvanized Gutters &#8211; Install<\/p><p>\u00a0\u00a0\u00a0 Galvanized Gutters &#8211; Repair<\/p><p>\u00a0\u00a0 Gutter Cleaning<\/p><p>\u00a0\u00a0 Install or Replace Gutter Covers and Accessories<\/p><p>\u00a0\u00a0 PVC Gutters &#8211; Install<\/p><p>\u00a0\u00a0 PVC Gutters &#8211; Repair<\/p><p>\u00a0\u00a0 Seamless Metal Gutters &#8211; Install<\/p><p>\u00a0\u00a0 Seamless Metal Gutters &#8211; Repair<\/p><p>\u00a0\u00a0 Wood Gutters &#8211; Install<\/p><p>\u00a0\u00a0 Wood Gutters &#8211; Repair<\/p><\/td><td width=\"113\"><p>Install or Replace Gutter Covers and Accessories<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p><strong>Home Improvement &#8211; Remodeling related fields:<\/strong><\/p><table width=\"0\"><tbody><tr><td width=\"98\"><p><strong>Ping Required<\/strong><\/p><\/td><td width=\"98\"><p><strong>Post Required<\/strong><\/p><\/td><td width=\"125\"><p><strong>Field name<\/strong><\/p><\/td><td width=\"237\"><p><strong>Values<\/strong><\/p><\/td><td width=\"113\"><p><strong>Example<\/strong><\/p><\/td><\/tr><tr><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"98\"><p><strong>YES<\/strong><\/p><\/td><td width=\"125\"><p>Remodeling<\/p><\/td><td width=\"237\"><p>Set. Allowed values:<br \/>\u00a0\u00a0\u00a0\u00a0Attic Remodel\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>\u00a0\u00a0\u00a0 Basement Remodel\u00a0\u00a0\u00a0\u00a0<\/p><p>\u00a0\u00a0\u00a0 Bathroom Remodel<\/p><p>\u00a0\u00a0\u00a0 Garage Build\u00a0<\/p><p>\u00a0\u00a0 Garage Remodel\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>\u00a0\u00a0\u00a0 General Contractors<\/p><p>\u00a0\u00a0\u00a0\u00a0 Home Addition\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>\u00a0\u00a0\u00a0\u00a0 Kitchen Remodel\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/p><p>\u00a0\u00a0\u00a0\u00a0 Major Renovation &#8211; Multiple Rooms<\/p><p>\u00a0\u00a0\u00a0\u00a0 Remodel or Renovate 1+ Rooms<\/p><p>\u00a0\u00a0\u00a0\u00a0 Remodel to Accommodate a Disability<\/p><\/td><td width=\"113\"><p>Install or Replace Gutter Covers and Accessories<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><h1>HTTP Examples<\/h1><p><strong>Ping<\/strong>\u00a0&#8211; https:\/\/viberant.leadportal.com\/new_api\/api.php?Mode=ping<\/p><table width=\"0\"><tbody><tr><td width=\"189\"><p>Key<\/p><\/td><td width=\"473\"><p>***<\/p><\/td><\/tr><tr><td width=\"189\"><p>API_Action<\/p><\/td><td width=\"473\"><p>pingPostLead<\/p><\/td><\/tr><tr><td width=\"189\"><p>Return_Best_Price<\/p><\/td><td width=\"473\"><p>1<\/p><\/td><\/tr><tr><td width=\"189\"><p>TYPE<\/p><\/td><td width=\"473\"><p>33<\/p><\/td><\/tr><tr><td width=\"189\"><p>IP_Address<\/p><\/td><td width=\"473\"><p>75.2.92.149<\/p><\/td><\/tr><tr><td width=\"189\"><p>SRC<\/p><\/td><td width=\"473\"><p>test<\/p><\/td><\/tr><tr><td width=\"189\"><p>Zip<\/p><\/td><td width=\"473\"><p>60610<\/p><\/td><\/tr><tr><td width=\"189\"><p>Homeowner<\/p><\/td><td width=\"473\"><p>Yes<\/p><\/td><\/tr><tr><td width=\"189\"><p>Project<\/p><\/td><td width=\"473\"><p>Appliances<\/p><\/td><\/tr><\/tbody><\/table><p><strong>Post<\/strong>\u00a0&#8211; https:\/\/viberant.leadportal.com\/new_api\/api.php?Mode=post<\/p><table width=\"0\"><tbody><tr><td width=\"189\"><p>Key<\/p><\/td><td width=\"473\"><p>***<\/p><\/td><\/tr><tr><td width=\"189\"><p>API_Action<\/p><\/td><td width=\"473\"><p>pingPostLead<\/p><\/td><\/tr><tr><td width=\"189\"><p>Lead_ID<\/p><\/td><td width=\"473\"><p>1234<\/p><\/td><\/tr><tr><td width=\"189\"><p>TYPE<\/p><\/td><td width=\"473\"><p>33<\/p><\/td><\/tr><tr><td width=\"189\"><p>IP_Address<\/p><\/td><td width=\"473\"><p>75.2.92.149<\/p><\/td><\/tr><tr><td width=\"189\"><p>SRC<\/p><\/td><td width=\"473\"><p>test<\/p><\/td><\/tr><tr><td width=\"189\"><p>Landing_Page<\/p><\/td><td width=\"473\"><p>landing<\/p><\/td><\/tr><tr><td width=\"189\"><p>First_Name<\/p><\/td><td width=\"473\"><p>John<\/p><\/td><\/tr><tr><td width=\"189\"><p>Last_Name<\/p><\/td><td width=\"473\"><p>Doe<\/p><\/td><\/tr><tr><td width=\"189\"><p>City<\/p><\/td><td width=\"473\"><p>Chicago<\/p><\/td><\/tr><tr><td width=\"189\"><p>State<\/p><\/td><td width=\"473\"><p>IL<\/p><\/td><\/tr><tr><td width=\"189\"><p>Zip<\/p><\/td><td width=\"473\"><p>60610<\/p><\/td><\/tr><tr><td width=\"189\"><p>Primary_Phone<\/p><\/td><td width=\"473\"><p>3125552057<\/p><\/td><\/tr><tr><td width=\"189\"><p>Email<\/p><\/td><td width=\"473\"><p>test@nags.us<\/p><\/td><\/tr><tr><td width=\"189\"><p>Homeowner<\/p><\/td><td width=\"473\"><p>Yes<\/p><\/td><\/tr><tr><td width=\"189\"><p>Project<\/p><\/td><td width=\"473\"><p>Appliances<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p>Response Matched Example<\/p><p><em>\u00a0<\/em><\/p><p><em>JSON<\/em><\/p><p>{<\/p><p>\u00a0 &#8220;response&#8221;: {<\/p><p>\u00a0\u00a0\u00a0 &#8220;status&#8221;: &#8220;Matched&#8221;,<\/p><p>\u00a0\u00a0\u00a0 &#8220;lead_id&#8221;: &#8220;874&#8221;,<\/p><p>\u00a0\u00a0\u00a0 &#8220;price&#8221;: &#8220;25&#8221;<\/p><p>\u00a0 }<\/p><p>}<\/p><p>\u00a0<\/p><p>\u00a0<\/p><p>\u00a0Response Unmatched Example<\/p><p><em>\u00a0<\/em><\/p><p><em>JSON<\/em><\/p><p>{<\/p><p>\u00a0 &#8220;response&#8221;: {<\/p><p>\u00a0\u00a0\u00a0 &#8220;status&#8221;: &#8220;Unmatched&#8221;,<\/p><p>\u00a0\u00a0\u00a0 &#8220;lead_id&#8221;: &#8220;874&#8221;<\/p><p>\u00a0 }<\/p><p>}<\/p><table width=\"0\"><thead><tr><td width=\"102\"><p><strong>Name<\/strong><\/p><\/td><td width=\"267\"><p><strong>Description<\/strong><\/p><\/td><td width=\"312\"><p><strong>Note<\/strong><\/p><\/td><\/tr><\/thead><tbody><tr><td width=\"102\"><p>status<\/p><\/td><td width=\"267\"><p>Status<\/p><\/td><td width=\"312\"><p>\u00a0<\/p><\/td><\/tr><tr><td width=\"102\"><p>lead_id<\/p><\/td><td width=\"267\"><p>ID number of successfully submitted lead<\/p><\/td><td width=\"312\"><p>Returned on success<\/p><\/td><\/tr><tr><td width=\"102\"><p>price<\/p><\/td><td width=\"267\"><p>The best price at which a lead can be accepted.<\/p><\/td><td width=\"312\"><p>Returned on success and only if\u00a0<strong>Return_Best_Price<\/strong>\u00a0was submitted in &#8220;ping&#8221;<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p>\u00a0<\/p><p>\u00a0<\/p><p>\u00a0Response &#8211; error<\/p><p><em>JSON<\/em><\/p><p>{<\/p><p>\u00a0 &#8220;response&#8221;: {<\/p><p>\u00a0\u00a0\u00a0 &#8220;status&#8221;: &#8220;Error&#8221;,<\/p><p>\u00a0\u00a0\u00a0 &#8220;error&#8221;: &#8220;Required value First_Name is missing&#8221;<\/p><p>\u00a0 }<\/p><p>}<\/p><table width=\"0\"><thead><tr><td width=\"170\"><p><strong>Name<\/strong><\/p><\/td><td width=\"170\"><p><strong>Description<\/strong><\/p><\/td><td width=\"321\"><p><strong>Note<\/strong><\/p><\/td><\/tr><\/thead><tbody><tr><td width=\"170\"><p>error<\/p><\/td><td width=\"170\"><p>Error message<\/p><\/td><td width=\"321\"><p>Returned on error<\/p><\/td><\/tr><tr><td width=\"170\"><p>status<\/p><\/td><td width=\"170\"><p>Status<\/p><\/td><td width=\"321\"><p>\u00a0<\/p><\/td><\/tr><\/tbody><\/table><p>\u00a0<\/p><p>*** Note<\/p><ol><li>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).<\/li><\/ol><p>***<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 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&#8211; API key SRC&#8211; ID Landing_Page&#8211; site URL where<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_sitemap_exclude":false,"_sitemap_priority":"","_sitemap_frequency":"","footnotes":""},"class_list":["post-11816","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/pages\/11816","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/comments?post=11816"}],"version-history":[{"count":4,"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/pages\/11816\/revisions"}],"predecessor-version":[{"id":11820,"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/pages\/11816\/revisions\/11820"}],"wp:attachment":[{"href":"https:\/\/homerevive.co\/hr-api\/wp\/v2\/media?parent=11816"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}