Auto Warranty Leads

The Auto Warranty endpoint allow you as a Publisher to post Auto Warranty leads directly to Bright Horizons Media. Leads sent to the API use the POST method and require both credentials and your Publisher to be enabled for posting Auto Warranty leads. Leads are posted in JSON format.

Excluded states: CA, MA, OR. Must be employed. Ad copy must be apporoved before going live. DBAs/marketing partners to add to list: PMC, Endurance, Warranty Protection Svcs, Integrity Admin. Vehicle age: 12 years old or newer.

Method	Endpoint	Endpoint Type
Post	https://api.brighthorizonsmedia.com/post/auto-warranty/	JSON

POST PARAMETERS

To successfully post Auto Warranty leads, two arrays need to be passed to the JSON endpoint: the xauth[] array and the transaction[] array.

The xauth[] array contains your Publisher ID and the API key assigned by your Account Manager.

The transaction[] contains all the details about the lead (first name, last name, email, consumer IP, vehicle details, etc.).

xauth[] Parameters

Field	Type	Required?	Description
affiliateid	INT	Yes	Your Publisher Id (aka Affiliate Id) provided by your Account Manager
key	STRING (36)	Yes	The API Key provided by your Account Manager.

transaction[] Parameters

Field	Type	Required	Description
firstname	STRING	Yes	First name as provided by the consumer
lastname	STRING	Yes	Last name as provided by the consumer
dob	STRING	Yes	Date of birth as provide by the consumer. Must be in the format YYYY-MM-DD.
phone	STRING	Yes	Phone number as provided by the consumer. Can be passed in any format (see following examples) but must be a valid phone number with 10 digits. Examples: 3105551212, (310) 555-1212, 310-555-1212, 310.555.1212.
auto	ARRAY	Yes	The auto parameter is an array containing key => value pairs of year, make, model and mileage of the vehicle. All four are required. year (INT) - must be a valid year and greater than 20 years ago make (STRING) - the make (aka brand) of the vehicle as provided by the consumer model (STRING) - the model of the vehicle as provided by the consumer mileage (INT) - current mileage of the vehicle as provided by the consumer and must be less than 200,000 miles. This may be optional for you; please ask your Account Manager.
ip	STRING	Yes	The IP address of the consumer when the form was submitted on your website (not your server IP address). Can be either IPV4 or IPv6.
source	STRING	Yes	The fully qualified URL of the webpage where the lead was generated (excluding any query string parameters)
email	STRING	Yes	Email address as provided by the consumer
address	STRING	Yes	Street address as provided by the consumer
address2	STRING	Optional	Street address as provided by the consumer
city	STRING	Yes	City as provided by the consumer. If not provided, we will map the city based on the zip code provided.
state	CHAR (2)	Yes	The state abbreviation as provided by the consumer. If not provided, we will map the state based on the zip code provided.
zip	STRING	Yes	The zip code as provided by the consumer. For US zip codes, make sure to include any leading zeros to ensure the zip code has a length of 5 characters.
sub1	STRING	Yes	Additional field for tracking purposes
sub2	STRING	Optional	Additional field for tracking purposes
sub3	STRING	Optional	Additional field for tracking purposes
sub4	STRING	Optional	Additional field for tracking purposes
sub5	STRING	Optional	Additional field for tracking purposes
trustedformcertid	STRING	Yes	The TrustedForm URL
jornayaleadid	STRING	Optional

REQUESTS & RESPONSES

SAMPLE REQUEST

POST /post/auto-warranty/ HTTP/1.1
Host: https://api.brighthorizonsmedia.com
Content-Type: application/json; charset=utf-8
Content-Length: 868

{
    "xauth":
    {
        "affiliateid": 2,
        "key": "869sdf83-rr5t-e9o7-5t7m-3d4b9m2z3bb9"
    },
    "transaction":
    {
        "firstname": "JJ",
        "lastname": "McClure",        
        "phone": "7025551212",
        "auto": {
            "year": 2021,
            "make": "Buick",
            "model": "Enclave",
            "mileage": 85000
        },
        "ip": "184.248.249.118",
        "source": "yourdomain.com",
        "email": "jjmcclure@example.com",
        "address": "123 Cannonball Lane",
        "address2": "Apt 3",
        "city": "Boulder City",
        "state": "NV",
        "zip": "89002",
        "sub1": "your subid for tracking",
        "sub2": "",
        "sub3": "",
        "sub4": "",
        "sub5": "",
        "trustedformcertid": "https://cert.trustedform.com/XXdXX8ba26XX85bXX16d3cb6c44cc30a7da48ba1"
    }
}

SAMPLE RESPONSE

When an Auto Warranty lead is posted to us, a JSON response will be returned containing useful information about whether the lead was accepted and any additional information we can provide. Below is an example of a successful response.

A response with sold = 1 (or "sold":1) means the lead was accepted by a buyer and is billable. Sold = 0 (or "sold":0) is NOT billable.

The "accepted" parameter is not to be used for determining whether a lead is billable.

{
    "validated": 1,
    "accepted": 1,
    "sold": 1,
    "disposition": ,
    "messages": [],
    "errors": [],    
    "transactionid": 123456789,
    "leadid": 123456789
}

FAILED RESPONSE

If the request failed, the response will include an errors object which may contain 1 or more messages/errors. This example will return an errors because the auto array was not passed in containing the year, make, model and mileage key/value pairs. Reminder, we do not log or record leads in our system that could not be validated.

{
    "validated": 0,
    "accepted": 0,
    "sold": 0,
    "disposition": ,
    "messages":
    [
        "Auto Warranty Lead could not be validated"
    ],
    "errors":
    [
        [
            "Model Year (required): can not be empty",
            "Make (required): can not be empty",
            "Model (required): can not be empty",
            "Mileage (required): can not be empty"
        ]
    ]
}