Mass Tort Roundup Leads
The Mass Tort Roundup enpoint allow you as a Publisher to post Mass Tort Roundup 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 Mass Tort Roundup leads. Leads are posted in JSON format.
Creative and TCPA must be approved before running. TCPA for offer must be: By clicking "Yes" I expressly authorize Legal Assist to call or text me at the phone number XXX-XXX XXXX using an automated dialer and prerecorded messages in order to see if I am eligible. Accepting this consent is not required to obtain any good or service.
Targeting: Hours - 24/7, Age - 50 to 80, Gender - Male, All States except Florida
| Method | Endpoint | Endpoint Type |
|---|---|---|
| Post | https://api.brighthorizonsmedia.com/post/mass-tort/roundup/ | JSON |
POST PARAMETERS
To successfully post Mass Tort Roundup 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, 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. |
| gender | STRING | Yes | The gender as provided by the consumer. Must be either "male" or "female". |
| 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. |
| STRING | Yes | Email address as provided by the consumer | |
| address | STRING | Yes | Street address as provided by the consumer |
| address2 | STRING | Optional | |
| city | STRING | Yes | City as provided by the consumer |
| state | CHAR (2) | Yes | The state abbreviation as provided by the consumer |
| 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. |
| source | STRING | Yes | The fully qualified URL of the webpage where the lead was generated (excluding any query string parameters) |
| 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. |
| useragent | STRING | Yes | The browser user agent captured when the consumer submitted the lead |
| acceptlanguage | STRING | Yes | The Accept-Language header captured from the consumer's browser when the consumer submitted the request. Refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language for more details about the Accept-Language request header. If you do not collect this value, you may pass the value: en-US. |
| trustedformcertid | STRING | Yes | The full TrustedForm URL of where the consumer submitted the lead |
| 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 |
REQUESTS & RESPONSES
SAMPLE REQUEST
POST /post/mass-tort/hair-straightener/ HTTP/1.1
Host: https://api.brighthorizonsmedia.com
Content-Type: application/json; charset=utf-8
Content-Length: 561
{
"xauth": {
"affiliateid": 123456,
"key": "96852585-58lk-5g5r-63jk8-25lp2574poiu"
},
"transaction": {
"firstname": "JJ",
"lastname": "McClure",
"gender": "male",
"dob": "1982-07-03",
"phone": "7025551212",
"email": "jjmcclure@example.com",
"address": "123 Cannonball Lane",
"address2": "",
"city": "Boulder City",
"state": "NV",
"zip": 89002,
"ip": "192.168.168.1",
"source": "https://yourdomain.com/path",
"useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36",
"acceptlanguage": "en-US,en;q=0.5",
"trustedformcertid": "https://cert.trustedform.com/zz2z1zzz11zz4z57z212z7z1f36z007f05zz3zzz",
"sub1": "your_sub_id",
"sub2": "",
"sub3": "",
"sub4": "",
"sub5": ""
}
}
SAMPLE RESPONSE
When a Mass Tort Roundup 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": "SOLD",
"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 error messages. This example will return an error message because the Publisher Id was not passed through the pubid parameter.
{
"validated": 0,
"accepted": 0,
"sold": 0,
"disposition": "REJECTED",
"messages": [
"Mass Tort > AFFF lead could not be validated"
],
"errors":
[
[
"Email Address (required): could not validate email address",
"Phone (required): can not be blank"
]
]
}