Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
settings
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/{campaign_id}/settings?api_key=YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Campaign",
    "track_settings": "DONT_TRACK_EMAIL_OPEN",
    "stop_lead_settings": "CLICK_ON_A_LINK",
    "send_as_plain_text": false,
    "follow_up_percentage": 100,
    "enable_ai_esp_matching": true
  }'

{
  "success": true,
  "data": {
    "message": "Settings updated successfully"
  }
}
Updates campaign configuration including: tracking settings (enable/disable opens and clicks - array format with DONT_EMAIL_OPEN/DONT_LINK_CLICK values), sending limits (max_leads_per_day, min_time_between_emails), stop conditions (when to stop emailing leads - REPLY_TO_AN_EMAIL/OPENED_EMAIL/CLIC…

​
Overview

Updates campaign configuration including: tracking settings (enable/disable opens and clicks - array format with DONT_EMAIL_OPEN/DONT_LINK_CLICK values), sending limits (max_leads_per_day, min_time_between_emails), stop conditions (when to stop emailing leads - REPLY_TO_AN_EMAIL/OPENED_EMAIL/CLICKED_LINK), AI ESP matching (intelligently pair leads with optimal email accounts), plain text mode (send_as_plain_text for better deliverability with technical audiences), follow-up percentage, and unsubscribe text Key Features:
  • Validates settings before applying

​
Path Parameters

​
campaign_id
number
required
The ID of the campaign to update

​
Query Parameters

​
api_key
string
required
Your SmartLead API key

​
Request Body

​
name
string
Campaign name
​
track_settings
string
Email tracking configuration. Allowed values: DONT_TRACK_EMAIL_OPEN, DONT_TRACK_LINK_CLICK, DONT_TRACK_REPLY_TO_AN_EMAIL
​
stop_lead_settings
string
When to stop emailing a lead. Allowed values: CLICK_ON_A_LINK, OPEN_AN_EMAIL
​
unsubscribe_text
string
Unsubscribe text to append to emails
​
send_as_plain_text
boolean
Send emails as plain text (no HTML)
​
force_plain_text
boolean
Force convert all emails to plain text
​
follow_up_percentage
integer
Follow-up percentage (0-100)
​
client_id
integer
Client ID. Leave as null if not needed
​
enable_ai_esp_matching
boolean
Use AI to match leads with best email accounts
​
auto_pause_domain_leads_on_reply
boolean
Pause leads from same domain after reply
​
ignore_ss_mailbox_sending_limit
boolean
Ignore SmartSenders mailbox sending limit
​
bounce_autopause_threshold
string
Bounce auto-pause threshold
​
domain_level_rate_limit
boolean
Enable domain-level rate limiting
​
out_of_office_detection_settings
object
Out of office detection configuration
​
ai_categorisation_options
array
AI categorisation options
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/{campaign_id}/settings?api_key=YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Campaign",
    "track_settings": "DONT_TRACK_EMAIL_OPEN",
    "stop_lead_settings": "CLICK_ON_A_LINK",
    "send_as_plain_text": false,
    "follow_up_percentage": 100,
    "enable_ai_esp_matching": true
  }'

​
Response Codes

​
200
Success
Request successful
​
400
Bad Request
Invalid request parameters or malformed request body
​
401
Unauthorized
Invalid or missing API key. Check your authentication.
​
404
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
​
422
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
​
429
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
​
500
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
​
503
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.
{
  "success": true,
  "data": {
    "message": "Settings updated successfully"
  }
}

​
Settings Explained

​
Track Settings

Control what gets tracked in your emails:
  • track_open: Adds tracking pixel to detect opens
  • track_click: Wraps links to track clicks
Disable tracking for privacy-focused outreach or when targeting technical audiences who may block tracking.

​
Sending Limits

  • sending_limit: Daily cap across all email accounts
  • min_time_btwn_emails: Prevents rapid-fire sending (appears more natural)

​
Stop Lead Settings

  • REPLY_TO_AN_EMAIL: Most common - stop when they engage
  • OPENED_EMAIL: Conservative - stop after they show interest
  • CLICKED_LINK: Stop when they click a link

​
AI ESP Matching

When enabled, SmartLead’s AI:
  • Matches leads with appropriate sender accounts
  • Considers lead’s email provider
  • Optimizes for deliverability
  • Balances account usage

​
Implementation Details

Settings changes affect only future sends. In-progress leads continue with old settings. Response Format: object