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

​
Overview

Blocks specific contacts at the workspace level using their LinkedIn public identifiers. Once blocked at workspace level, these leads will not receive messages from any campaign in the workspace.

​
Use Cases

  • Global Block List: Block contacts across all campaigns in your workspace
  • Compliance Management: Maintain a centralized list of contacts who should not be contacted
  • Protect Relationships: Prevent outreach to existing clients, partners, or sensitive contacts
  • Quality Control: Block leads that consistently 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/blocked-leads \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "leads": [
      {
        "publicIdentifier": "john-doe",
        "reason": "Existing client"
      },
      {
        "publicIdentifier": "jane-smith",
        "reason": "Requested opt-out"
      }
    ]
  }'

​
Request Details

This endpoint requires an API key for authentication and accepts an array of lead objects with their LinkedIn public identifiers and optional blocking reasons.

​
Request Body

The body should contain:
  • leads (required): Array of objects with:
    • publicIdentifier (required): LinkedIn public identifier
    • reason (optional): Reason for blocking this lead

​
Public Identifiers

The publicIdentifier 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

  • The leads array is required and must not be empty
  • You can block multiple leads in a single request
  • Blocked leads at workspace level are excluded from all campaigns in the workspace
  • The reason field is optional but recommended for tracking purposes
  • This is a public route that requires API key authentication
  • Workspace-level blocks take precedence over campaign-specific settings

​
Example Request Body

{
  "leads": [
    {
      "publicIdentifier": "john-doe",
      "reason": "Existing client"
    },
    {
      "publicIdentifier": "jane-smith",
      "reason": "Requested opt-out"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Body

application/json

Leads to block with LinkedIn public identifiers

​
leads
object[]
required

Array of lead objects to block

Response

Leads blocked successfully

​
success
boolean

Whether the operation was successful

​
message
string

Response message

​
blocked
integer

Number of leads blocked