Skip to main content
POST
/
v1
/
campaigns
/
{campaignId}
/
blocked-leads
Add Lead to Campaing-Blocklist
curl --request POST \
  --url https://app-api.walead.ai/api/v1/campaigns/{campaignId}/blocked-leads \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "publicIdentifiers": [
    "<string>"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "blocked": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.walead.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Blocks specific contacts in a campaign using their LinkedIn public identifiers. Once blocked, these leads will not receive any messages from the campaign.
License Requirement: This endpoint requires a Pro or Agency license to use.

​
Use Cases

  • Prevent Outreach: Block specific LinkedIn profiles from receiving campaign messages
  • Compliance: Exclude contacts who have requested not to be contacted
  • Quality Control: Remove leads that don’t match your targeting criteria

​
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 POST 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" \
  -d '{
    "publicIdentifiers": [
      "john-doe",
      "jane-smith"
    ]
  }'

​
Request Details

This endpoint requires an API key for authentication and accepts an array of LinkedIn public identifiers to block.

​
Public Identifiers

The publicIdentifiers field should contain LinkedIn profile identifiers (the username part of a LinkedIn URL). For example, from linkedin.com/in/john-doe, the public identifier would be john-doe.

​
Important Notes

  • License Required: Pro or Agency license is required to use this endpoint
  • The publicIdentifiers array is required and must not be empty
  • You can block multiple leads in a single request
  • Blocked leads will be excluded from all campaign activities
  • This is a public route that requires API key authentication

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Path Parameters

​
campaignId
string
required

Campaign ID

Body

application/json

Public identifiers of leads to block

​
publicIdentifiers
string[]
required

Array of LinkedIn public identifiers to block (e.g., 'john-doe' from linkedin.com/in/john-doe)

Response

Leads blocked successfully

​
success
boolean

Whether the operation was successful

​
message
string

Response message

​
blocked
integer

Number of leads blocked