Skip to main content
POST
/
api
/
v1
/
leads
/
{lead_id}
/
unsubscribe
curl -X POST "https://server.smartlead.ai/api/v1/leads/456/unsubscribe?api_key=YOUR_KEY"
{
  "ok": true
}
This action unsubscribes the lead globally across all campaigns in your account. The lead will not receive any future emails from any campaign. This action cannot be undone via API.

Path Parameters

lead_id
number
required
The lead ID to unsubscribe globally

Query Parameters

api_key
string
required
Your SmartLead API key
curl -X POST "https://server.smartlead.ai/api/v1/leads/456/unsubscribe?api_key=YOUR_KEY"

Response Codes

200
Success
Lead unsubscribed successfully
401
Unauthorized
Invalid or missing API key
404
Not Found
Lead not found or you don’t have access to it
500
Internal Server Error
Server error occurred
{
  "ok": true
}

Behavior Notes

When a lead is globally unsubscribed:
  • The is_unsubscribed flag is set to true on the lead record
  • The lead will not receive emails from any campaign
  • The lead remains in all campaigns but will not be contacted
  • This action affects all current and future campaigns
To unsubscribe a lead from a specific campaign only (not globally), use the campaign-specific unsubscribe endpoint: POST /api/v1/campaigns/{campaign_id}/leads/{lead_id}/unsubscribe