curl -X POST "https://server.smartlead.ai/api/v1/campaigns/123/leads/456/pause?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
campaign_id = 123
lead_id = 456
response = requests.post(
f"https://server.smartlead.ai/api/v1/campaigns/{campaign_id}/leads/{lead_id}/pause",
params={"api_key": API_KEY}
)
result = response.json()
if result.get('ok'):
print(f"Lead {lead_id} paused successfully")
const API_KEY = 'YOUR_API_KEY';
const campaignId = 123;
const leadId = 456;
const response = await fetch(
`https://server.smartlead.ai/api/v1/campaigns/${campaignId}/leads/${leadId}/pause?api_key=${API_KEY}`,
{ method: 'POST' }
);
const result = await response.json();
if (result.ok) {
console.log(`Lead ${leadId} paused successfully`);
}
{
"ok": true,
"data": "success"
}
{
"message": "Invalid API Key"
}
{
"error": "Campaign not found - Invalid campaign_id."
}
Lead Management
Pause Lead
Temporarily pause email sending for a specific lead in a campaign
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
leads
/
{lead_id}
/
pause
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/123/leads/456/pause?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
campaign_id = 123
lead_id = 456
response = requests.post(
f"https://server.smartlead.ai/api/v1/campaigns/{campaign_id}/leads/{lead_id}/pause",
params={"api_key": API_KEY}
)
result = response.json()
if result.get('ok'):
print(f"Lead {lead_id} paused successfully")
const API_KEY = 'YOUR_API_KEY';
const campaignId = 123;
const leadId = 456;
const response = await fetch(
`https://server.smartlead.ai/api/v1/campaigns/${campaignId}/leads/${leadId}/pause?api_key=${API_KEY}`,
{ method: 'POST' }
);
const result = await response.json();
if (result.ok) {
console.log(`Lead ${leadId} paused successfully`);
}
{
"ok": true,
"data": "success"
}
{
"message": "Invalid API Key"
}
{
"error": "Campaign not found - Invalid campaign_id."
}
Pausing a lead stops all scheduled emails. The lead status changes to
PAUSED and any drafted emails are marked as STOPPED.Path Parameters
number
required
The campaign ID containing the lead
number
required
The lead ID to pause
Query Parameters
string
required
Your SmartLead API key
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/123/leads/456/pause?api_key=YOUR_KEY"
import requests
API_KEY = "YOUR_API_KEY"
campaign_id = 123
lead_id = 456
response = requests.post(
f"https://server.smartlead.ai/api/v1/campaigns/{campaign_id}/leads/{lead_id}/pause",
params={"api_key": API_KEY}
)
result = response.json()
if result.get('ok'):
print(f"Lead {lead_id} paused successfully")
const API_KEY = 'YOUR_API_KEY';
const campaignId = 123;
const leadId = 456;
const response = await fetch(
`https://server.smartlead.ai/api/v1/campaigns/${campaignId}/leads/${leadId}/pause?api_key=${API_KEY}`,
{ method: 'POST' }
);
const result = await response.json();
if (result.ok) {
console.log(`Lead ${leadId} paused successfully`);
}
Response Codes
Success
Lead paused successfully
Unauthorized
Invalid or missing API key
Not Found
Campaign not found or you don’t have access to it
Internal Server Error
Server error occurred
{
"ok": true,
"data": "success"
}
{
"message": "Invalid API Key"
}
{
"error": "Campaign not found - Invalid campaign_id."
}
Behavior Notes
When a lead is paused:
- Lead status changes to
PAUSED - The
next_timestamp_to_reachis cleared - All drafted emails for this lead are marked as
STOPPED - No new emails will be scheduled until the lead is resumed
