Follow

SuppressionList Overview

What is a Suppression List?

Generally speaking, a suppression list is a list of leads that should not be contacted. It may be a list of individuals that have requested not to be emailed or called by your company. As such, they should be suppressed from any ongoing company communications. When running cost-per-lead advertising with 3rd party vendors, companies may want to reject any leads that are on their suppression file.

Does ActiveProspect offer a solution for managing a suppression list?

Yes, here is a link to more information: SuppressionList.

Using SupressionList with LeadConduit Classic

SupressionList is most often used for duplicate prevention or to prevent data which should be suppressed from acceptance into your campaign. Accomplishing this utilizes LeadConduit Classic's multi-destination behavior. Typically, there are two destinations, one for querying a suppression list and one for adding the current lead to your list. Setting up each destination is somewhat similar, however, between the two, the posting URLs, the request headers and the request bodies differ.

The first destination in your campaign will typically be a SupressionList query. At this step, the list is queried to see if the data in a delivery parameter is present or not. For example, you can check to see if a certain email or phone number is on the list. If the new lead data is not on your SuppressionList, LeadConduit Classic will continue onto the next destination as specified. See Query a SupressionList below for the specifics on setting this up.

Another LeadConduit Classic delivery destination is used to add data to the current lead to your SuppressionList. This additional destination will add the value of the chosen delivery parameter to your SupressionList. That way, the new lead data is there from the beginning when the next lead comes through. See Add Current Lead to SuppressionList with LeadConduit Classic below for more information.

Query a SupressionList with LeadConduit Classic

SuppressionList may be queried to test whether the data for a certain LeadConduit Classic campaign's delivery parameter is present in the List. Following are step-by-step instructions. This example uses the LeadConduit Classic campaign field named “email”.

Log into your SupressionList account to get the URL Name and API key for the list you want to query.

Let's assume your list's URL Name is "mylist", and your SuppressionList APi key is "c20766cfc8abc2e761995dc27dd18a4c".
Make a note of these items.

Create a Base-64 encoded string from the name of your SuppressionList, followed by a colon, followed by your API key like this:

mylist:c20766cfc8abc2e761995dc27dd18a4c

(A good online utility for creating Base-64 encoded strings is at http://ostermiller.org/calc/encode.html )

This should result in a string value similar to this:
bXlsaXN0OmMyMDc2NmNmYzhhYmMyZTc2MTk5NWRjMjdkZDE4YTRj

Make a note of the value.

Next, log into your campaign in LeadConduit Classic and create a new custom HTTP POST delivery.

For the Posting URL enter:
https://app.suppressionlist.com/exists/mylist/#{email}
(Remember to change "mylist" and "email" as appropriate for your campaign.)

In Request headers, for the header named Content-Type, enter a value of: application/x-www-form-urlencoded

Add a new header named "Authorization". For the value of this header, enter the word "Basic" followed by a space, followed by the Base-64 encoded string you created earlier, like this:
Basic bXlsaXN0OmZjMzZjODE2OGNiYjE2Nzg0ZjZhMjlmODk2OTVkZDky

In the request body, enter the following:
#if(#{empty[email]})
#else
#end

Valid response pattern:
(.*)

Check the box for "apply it to 4XX HTTP status codes also"

Success Response Pattern:
.*("found":false).*

For Failure Reason, check "Always use this reason" and enter:
"User Suppressed"

Multi-Destination Behavior:
On delivery success: continue to next destination
On delivery failure: do not continue to next destination
On delivery error: do not continue to next destination, retry later

If the lead is found in "mylist", the delivery chain will halt as a rejection at this point. If it is not found, this delivery will be considered a success and the lead will move on to the next delivery in the chain.

Add Current Lead to SupressionList with LeadConduit Classic

Adding the current lead to your SuppressionList allows you to check and compare future leads against the List. Following are step-by-step instructions. This example uses the LeadConduit Classic campaign field named “email”.

Log into your SupressionList account to get the URL Name and API key for the list you want to add to.

Let's assume your list's URL Name is "mylist", and your SuppressionList APi key is "c20766cfc8abc2e761995dc27dd18a4c".
Make a note of these items.

Create a Base-64 encoded string from the name of your SuppressionList, followed by a colon, followed by your API key like this:

mylist:c20766cfc8abc2e761995dc27dd18a4c

(A good online utility for creating Base-64 encoded strings is at http://ostermiller.org/calc/encode.html )

This should result in a string value similar to this:
bXlsaXN0OmMyMDc2NmNmYzhhYmMyZTc2MTk5NWRjMjdkZDE4YTRj

Make a note of the value.

Next, log into your campaign in LeadConduit Classic and create a new custom HTTP POST delivery.

For the posting URL enter:
https://app.suppressionlist.com/lists/mylist/items
(Remember to change "mylist" as appropriate for your campaign.)

In Request headers, for the header named Content-Type, enter a value : application/json

Add a new header named Accept and again enter the value : application/json

Add another new header named "Authorization". For the value of this header, enter the word "Basic" followed by a space, followed by the Base-64 encoded string you created earlier, like this:
Basic bXlsaXN0OmMyMDc2NmNmYzhhYmMyZTc2MTk5NWRjMjdkZDE4YTRj

In the request body, enter the following:
{"values":"#{email}"}

For Valid response pattern, enter:
(.*)

Check the box for "apply it to 4XX HTTP status codes also"

For Success Response Pattern, enter:
.("found":false).

For Failure Reason, check "Always use this reason" and enter:
"User Suppressed"

Under Multi-Destination Behavior:
On delivery success: continue to next destination
On delivery failure: do not continue to next destination
On delivery error: do not continue to next destination, retry later

If the lead is found in "mylist", the delivery chain will halt as a rejection at this point. If it is not found, this delivery will be considered a success and the lead will move on to the next delivery in the chain.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

You must be logged in to comment.