Skip to main content
GET
/
v1
/
campaigns
/
{campaignId}
/
blocked-leads
Get Campaign Blocked Leads
curl --request GET \
  --url https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads \
  --header 'x-api-key: <api-key>'
import requests

url = "https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "publicIdentifier": "<string>",
    "reason": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]
{
  "statusCode": 123,
  "message": "<string>"
}
{
  "statusCode": 123,
  "message": "<string>"
}

​
Overview

Retrieves the list of blocked leads for a specific campaign. This endpoint returns all LinkedIn profiles that have been blocked from receiving messages in this campaign.

​
Use Cases

  • Audit Blocked Contacts: Review which leads have been blocked in your campaign
  • Export Blocked List: Get a list of all blocked contacts for reporting purposes
  • Verification: Confirm that specific leads have been successfully blocked

​
Authentication

All requests require an API key passed in the x-api-key header. You can generate your API key from the WaLead dashboard.

​
Example Request

curl -X GET https://app-api.walead.ai/api/v1/campaigns/CAMPAIGN_ID/blocked-leads \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​
Request Details

This endpoint requires an API key for authentication and supports pagination through optional query parameters.

​
Query Parameters

  • skip (optional): Number of records to skip for pagination (default: 0)
  • take (optional): Number of records to return (default: 10, max: 100)

​
Response

The response includes an array of blocked leads with their details:
  • publicIdentifier: The LinkedIn public identifier of the blocked lead
  • reason: Optional reason for blocking (if provided when blocking)
  • createdAt: Timestamp when the lead was blocked

​
Important Notes

  • This endpoint requires API key authentication
  • Results are paginated to optimize performance
  • Use skip and take parameters to navigate through large lists of blocked leads
  • Blocked leads in a campaign are specific to that campaign only

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Path Parameters

​
campaignId
string
required

Campaign ID

Query Parameters

​
skip
integer
default:0

Number of records to skip for pagination (default: 0)

​
take
integer
default:10

Number of records to return (default: 10, max: 100)

Required range: x <= 100

Response

Blocked leads retrieved successfully

​
publicIdentifier
string

LinkedIn public identifier

​
reason
string | null

Reason for blocking

​
createdAt
string<date-time>

Timestamp when the lead was blocked