Handling 1:1 Consent using our REST API

Follow

What is it?

The FCC has set guidelines around capturing explicit consent. 

In short, you need to get your leads consent before submitting their data to each buyer.

If you'd like to read more detail about the upcoming FCC consent ruling, check this article out.

 

What can LeadByte do to help me?

We have developed the ability to -

  1. Evaluate whether a lead would be accepted based on delivery caps, scheduling, and predefined rules BEFORE a lead is submitted into your campaign.
  2. Dictate which deliveries can be included in the distribution process.

Combining these together, you are able to check which deliveries your lead would be applicable for, have them confirm which they consent to being sent to, and then instruct LeadByte of this choice.

 

How does that work?

Step 1 - Evaluating deliveries

You would do this using our Delivery Checker, a feature which uses our REST API.

Start by heading to the Admin > Tech Hub > REST API, editing your Administrator key and ensuring the Delivery checker permission is checked.

 

Using the information collected, submit a request to LeadByte in this format - 

[POST] https://[ACCOUNT].leadbyte.com/restapi/v1.3/leads/deliverychecker

{ "key": "MY-API-KEY", "campid": "MY-CAMPAIGN-REFERENCE", "campaign-field-name-1": "ABC", "campaign-field-name-3": "Chester"
}

 

This feature will be checking any information you provide in the against request rules set on the delivery, so ensure you include any fields related to these rules.

EG 

ca8d412b-5c33-4525-baa0-a7126fd2f6ec.png

The above example ruleset would require you to provide the Town/City collected and the DOB of your lead in order to accurately check the delivery is applicable.

 

LeadByte would respond with a list of all applicable Deliveries and the associated Buyers

{
  "status": "Success",
  "message": "See delivery results",
  "deliveryResults": [
    {
      "bid": "7039",
      "buyerReference": "Buyer 3",
      "deliveryId": "7404",
      "deliveryReference": "Broadband Savings"
    },
    {
      "bid": "6986",
      "buyerReference": "Buyer 2",
      "deliveryId": "7406",
      "deliveryReference": "Broadband Rocks"
    },
    {
      "bid": "6985",
      "buyerReference": "Buyer 1",
      "deliveryId": "7408",
      "deliveryReference": "Broadband Forever"
    }
  ]
}

You would use the above info to show your lead and have them choose which buyers they consent to, potentially, being contacted by.

 

It should be noted, that the entire above process is done before submitting a lead.

As a result, no personal information is stored when using the delivery checker.

 

Step 2 - Instructing LeadByte which deliveries can be used

Now you have a list of which Deliveries/Buyers may accept your lead and your lead has provided consent, it's time to submit your lead to LeadByte including the chosen delivery(s). 

This is done by performing a standard JSON lead submit request but with an additional array for delivery IDs.

 

[POST] https://[ACCOUNT].leadbyte.com/restapi/v1.3/leads
{
	"campid": "MY-CAMPAIGN-REFERENCE",
	"campaign-field-name-1": "ABC", 
"campaign-field-name-2": "123",
"campaign-field-name-3": "Chester" "firstname": "Keith", "lastname": "Chegwin", "building": "41", "street1": "Hope Street", "street2": "Red Hill House",
"delivery_ids": [ 7406, 7408 ]
}

Headers: X_KEY: MY-API-KEY

 

What happens in LeadByte?

LeadByte takes this lead submission and applies the delivery distribution settings on your campaign.

If you the campaign set to exclusive sell but evenly weight leads between all deliveries, LeadByte will do just that but ONLY selling between the deliveries included on your lead submission.

If the example lead submit above was sold to 7406 and an almost identical lead came in, it would be sold to 7408.

 

 

FAQs

Q - What fields does the Delivery checker return?

A - By default, the Delivery checker returns 4 fields 

  1. bid
  2. buyerReference
  3. deliveryId
  4. deliveryReference

 

However, if you'd like LeadByte to return more information about your Buyers then you can specify these fields in the initial outgoing request. Format shown below - 

"extrafields": [
		"field1", "field2"
	]

 

All additional fields supported shown below - 

  • street1
  • street2
  • towncity
  • county
  • country
  • postcode
  • telephone
  • vat_percentage
  • external_ref
  • external_ref_2
  • external_ref_3
  • external_ref_4
  • external_ref_5
  • buyer_revenue

The response from LeadByte would include the information you specified in this format - 

{
"status": "Success",
"message": "See delivery results",
"deliveryResults": [
{
"bid": "6985",
"buyerReference": "Buyer 1",
"deliveryId": "7344",
"deliveryReference": "FCC Delivery 1",
"extrafields": {
"street1": "9 Abbey Square",
"towncity": "Chester",
"postcode": "CH1 2HU",
"external_ref": "You could add Custom TCPA text here if you liked",
"buyer_revenue": "10.00"
}
}
]
}
Was this article helpful?
0 out of 0 found this helpful

Comments