Blacklist domains

Add domains to the blacklist. Blacklisting a domain does not immediately change the status of existing prospects. Instead, it prevents contacting prospects associated with that domain across all campaigns. A prospect's status will be updated to BLACKLISTED during campaign processing.

Request

Endpoint

POST https://api.woodpecker.co/rest/v2/blacklist/domains

Headers

x-api-key: {YOUR_API_KEY}
Content-type: application/json

For details on how to authenticate your requests, please see the authentication guide.

Body

info

You can add up to 500 domains per request.

{
  "domains": [
    "baddomain.com",
    "blacklistedomain.io",
    "nomoreemails.co"
  ]
}

Field	Type	Description
domains	array[string]	List of domains to blacklist

Request sample

Blacklist a list of domains

cURL

curl --request POST \
  --url "https://api.woodpecker.co/rest/v2/blacklist/domains" \
  --header "x-api-key: {YOUR_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "domains": [
      "baddomain.com",
      "blacklistedomain.io",
      "nomoreemails.co"
    ]
  }'

Python

import requests

def addBlacklistedDomains():
  url = "https://api.woodpecker.co/rest/v2/blacklist/domains"
  headers = {
    "x-api-key": "{YOUR_API_KEY}",
    "Content-Type": "application/json"
  }
  payload = {
    "domains": [
      "baddomain.com",
      "blacklistedomain.io",
      "nomoreemails.co"
    ]
  }

  response = requests.post(url, headers=headers, json=payload)

  if response.status_code == 200:
    print("POST successful:", response.json())
  else:
    print("POST failed with status:", response.status_code)

if __name__ == "__main__":
  addBlacklistedDomains()

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class WoodpeckerApiClient {
  private static final String API_KEY = "{YOUR_API_KEY}";

  public static void main(String[] args) {
    addBlacklistedDomains();
  }

  public static void addBlacklistedDomains() {
    try {
      String url = "https://api.woodpecker.co/rest/v2/blacklist/domains";
      String jsonData = "{"
        + "\"domains\": ["
        + "\"baddomain.com\","
        + "\"blacklistedomain.io\","
        + "\"nomoreemails.co\""
        + "]"
        + "}";

      HttpClient client = HttpClient.newHttpClient();
      HttpRequest request = HttpRequest.newBuilder()
        .uri(new URI(url))
        .header("x-api-key", API_KEY)
        .header("Content-Type", "application/json")
        .POST(HttpRequest.BodyPublishers.ofString(jsonData))
        .build();

      HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

      if (response.statusCode() == 200) {
        System.out.println("POST response: " + response.body());
      } else {
        System.err.println("POST request failed: " + response.statusCode());
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Node.js

const axios = require("axios");

async function addBlacklistedDomains() {
  const url = "https://api.woodpecker.co/rest/v2/blacklist/domains";
  const headers = {
    "x-api-key": "{YOUR_API_KEY}",
    "Content-Type": "application/json"
  };
  const data = {
    domains: [
      "baddomain.com",
      "blacklistedomain.io",
      "nomoreemails.co"
    ]
  };

  try {
    const response = await axios.post(url, data, { headers: headers });

    if (response.status === 200) {
      console.log("POST successful:", response.data);
    } else {
      console.error("POST failed with status:", response.status);
    }
  } catch (error) {
    console.error("Request error:", error.response?.status || error.message);
  }
}

addBlacklistedDomains();

Response

Response examples

200

Returns a list of successfully blacklisted domains, including those newly added and those already blacklisted.

{
  "domains": [
    "baddomain.com",
    "blacklistedomain.io",
    "nomoreemails.co"
  ]
}

Body schema

Field	Type	Description
domains	array[string]	List of blacklisted domains

400

Invalid request body or malformed request syntax.

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Domains parameter can not be empty" | "You can proceed with up to 500 elements in one request" | "All of passed domains were invalid" | "Value of domains is incorrect.",
  "timestamp": "2025-03-05 17:57:00"
}

Body schema

Field	Type	Description
title	string	A short title describing the error
status	integer	The HTTP status code
detail	string	A detailed message explaining the error
timestamp	string	The timestamp when the error occurred, YYYY-MM-DD HH:MM:SS UTC

401

An issue with authorization. Please review the authorization guide

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid api key",
  "timestamp": "2025-03-05 17:57:00"
}

Body schema

Field	Type	Description
title	string	A short title describing the error
status	integer	The HTTP status code
detail	string	A detailed message explaining the error
timestamp	string	The timestamp when the error occurred, YYYY-MM-DD HH:MM:SS UTC

404

Please review the request URL.

{
  "title": "Not Found",
  "status": 404,
  "detail": "Requested resource does not exist",
  "timestamp": "2025-03-05 17:57:00"
}

Body schema

Field	Type	Description
title	string	A short title describing the error
status	integer	The HTTP status code
detail	string	A detailed message explaining the error
timestamp	string	The timestamp when the error occurred, YYYY-MM-DD HH:MM:SS UTC

500

Unknown error, please try again later

{
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error has occurred. Please try again later.",
  "timestamp": "2025-03-05 17:57:00"
}

Body schema

Field	Type	Description
title	string	A short title describing the error
status	integer	The HTTP status code
detail	string	A detailed message explaining the error
timestamp	string	The timestamp when the error occurred, YYYY-MM-DD HH:MM:SS UTC