[API 2.0] Blacklisting emails and domains for agencies

How to blacklist domains & emails for all companies under your agency with one request

IN THIS ARTICLE:

  1. Introduction to blacklisting for agencies
  2. GET agency/blacklist/emails
  3. GET agency/blacklist/domains
  4. POST agency/blacklist/emails
  5. POST agency/blacklist/domains

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
}

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
}

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.


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.