Follow

Creating and Working with Query URLs

SuppressionList Query URLs are a great way to provide your lead sources the option to query / pre-ping your Lists without needing to disclose the actual List IDs or your Lists' private API key.

Once you've created a List and primed it with data, you can create source-specific Query URLs.

From the SuppressionList UI, select the Query URLs tab at the top.

If you've never created a Query URL before, the space on the left will be blank.

 

Create

To create a new list, click the + icon at the bottom left.

You'll be prompted to provide a name and select the list(s) you want this source to have access to.

 

Manage

All existing tokens will appear on the left menu.

Selecting a name will reveal the details, including the Query URL that you will provide to the source.

You'll also notice a listing of all your account's Lists. As you add Lists, you may want to allow a source access to that new list. Add / Remove access to lists, make your selections and select Save.

This is particularly useful if a source starts abusing the use of a list and you want to remove access. They can continue to make queries, but if no lists are enabled, there will be no response.

Deleting a Query URL is as simple as highlighting its name in the left-hand column, then clicking the "-" button at the bottom of that column.

 

Use

The Query URL you provide can be used by your source to determine if a phone number, email address, or whatever parameter you designate, is already on your list(s). The response will tell the source whether or not the information was found, and what lists were checked.

Query

$ curl -X GET https://app.suppressionlist.com/exists/{{token_id}}/test@email.com

Query Term Found

{
    "entries": [
        {
            "added_at": "2016-05-26T17:26:06Z",
            "list_id": "570296e6ec8d83bf8e000001",
            "list_url_name": "token_email_list"
        }
    ],
    "exists_in_lists": [
        "token_email_list"
    ],
    "found": true,
    "key": "test@email.com",
    "specified_lists": [
        "token_email_list"
    ]
}

Query Term Not Found

{
    "found": false,
    "key": "test@email.com",
    "specified_lists": [
        "token_email_list"
    ]
}

 

//--//

 

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.