Campaign Management
Update Campaign Settings
Updates campaign configuration including: tracking settings (enable/disable opens and clicks - array format with DONT_EM
POST
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
number
required
The ID of the campaign to update
Query Parameters
string
required
Your SmartLead API key
Request Body
string
Campaign name
array
Email tracking configuration. Pass an array of string values to disable specific tracking. Allowed values:
DONT_TRACK_EMAIL_OPEN, DONT_TRACK_LINK_CLICK, DONT_TRACK_REPLY_TO_AN_EMAIL. Pass an empty array [] to enable all tracking.string
When to stop emailing a lead. Allowed values:
CLICK_ON_A_LINK, OPEN_AN_EMAILstring
Unsubscribe text to append to emails
boolean
Send emails as plain text (no HTML)
boolean
Force convert all emails to plain text
integer
Follow-up percentage (0-100)
integer
Client ID. Leave as null if not needed
boolean
Use AI to match leads with best email accounts
boolean
Pause leads from same domain after reply
boolean
Ignore SmartSenders mailbox sending limit
string
Bounce auto-pause threshold
boolean
Enable domain-level rate limiting
object
Out of office detection configuration
boolean
Add an unsubscribe tag to outgoing emails
array
AI categorisation options
Response Codes
Success
Request successful
Bad Request
Invalid request parameters or malformed request body
Unauthorized
Invalid or missing API key. Check your authentication.
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.
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
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
