IN THIS ARTICLE:
Introduction to blacklisting for agencies
If you're running an agency and you want to blacklist emails and domains for all companies you manage, you can do it with our API. By that you can be sure no messages will be sent to the prospects with provided email addresses or from a specific domain.
If you're interested in blacklisting domains for a specific account, use endpoint mentioned here.
If you want to learn more about blacklisting for agencies, check this article.
GET agency/blacklist/emails
If you want to get the list of blacklisted emails, use the following request:
GET https://api.woodpecker.co/rest/v2/agency/blacklist/emails
Sample result:
{
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"total": 3
}
Response data type:
emails - JSON object, list of all blacklisted emails on a whole agency level.
total - number, number of blacklisted emails.
If there's no email added to blacklist, you'll get the following result:
{
"emails": [ ],
"total": 0
}You can manage your results with paging, which allows you to display emails in desired batches.
Available parameters:
per_page - number, defines a number of results per page.
page - number, defines a page number you want access to. First page is page=0.
GET https://api.woodpecker.co/rest/v2/agency/blacklist/emails?per_page=2
GET https://api.woodpecker.co/rest/v2/agency/blacklist/emails?page=10
The default number of emails per page is 100. You can increase this number up to 1000 by using a per_page parameter. Providing a higher number will narrow down the results to 1000.
GET agency/blacklist/domains
If you want to get the list of blacklisted domains, use the following request:
GET https://api.woodpecker.co/rest/v2/agency/blacklist/domains
Sample result:
{
"domains": [
"blacklisteddomain.com",
"gmail.com",
"nocontact.io"
],
"total": 3
}
Response data type:
domains - JSON object, list of all blacklisted domains on a whole agency level.
total - number, number of blacklisted emails.
If there's no domain added to blacklist, you'll get the following result:
{
"domains": [ ],
"total": 0
}You can manage your results with paging, which allows you to display emails in desired batches.
Available parameters:
per_page - number, defines the number of results per page.
page - number, defines a page number you want access to. First page is page=0.
GET https://api.woodpecker.co/rest/v2/agency/blacklist/domains?per_page=2
GET https://api.woodpecker.co/rest/v2/agency/blacklist/domains?page=10
The default number of domains per page is 100. You can increase this number up to 1000 by using a per_page parameter. Providing a higher number will narrow down the results to 1000.
POST agency/blacklist/emails
If you want to blacklist emails for all companies under your agency, use the following request:
POST https://api.woodpecker.co/rest/v2/agency/blacklist/emails
Request body:
{
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
}
As a response, you'll receive 201 Created status.
POST agency/blacklist/domains
If you want to blacklist domains for all companies under your agency, use the following request:
POST https://api.woodpecker.co/rest/v2/agency/blacklist/domains
Request body:
{
"domains": [
"blacklisteddomain.com",
"gmail.com",
"nocontact.io"
]
}
As a response, you'll receive 201 Created status.
DELETE agency/blacklist/emails
If you want to remove emails from blacklist for all companies under your agency, use the following request:
DELETE https://api.woodpecker.co/rest/v2/agency/blacklist/emails
Request body:
{
"emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
}
As a response, you'll receive 200 OK status.
DELETE agency/blacklist/domains
If you want to remove domains from blacklist for all companies under your agency, use the following request:
DELETE https://api.woodpecker.co/rest/v2/agency/blacklist/domains
Request body:
{
"domains": [
"blacklisteddomain.com",
"gmail.com",
"nocontact.io"
]
}
As a response, you'll receive 200 OK status.
Want to integrate with us?
If you're interested in building a native integration with Woodpecker, fill out this form and we'll get back to you.