Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
status
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/123/status?api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "START"}'
{
  "success": true,
  "message": "Campaign status updated successfully",
  "campaign": {
    "id": 123,
    "status": "ACTIVE"
  }
}
Change the status of a campaign (start, pause, stop) Updates campaign status to START, PAUSE, or STOP

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

status
string
required
New campaign statusValid values (from API_EMAIL_CAMPAIGN_STATUS):
  • START - Start or resume campaign (not “ACTIVE”)
  • PAUSED - Temporarily pause sending
  • STOPPED - Permanently stop campaign
Note: Use “START” not “ACTIVE” when activating a campaign
curl -X POST "https://server.smartlead.ai/api/v1/campaigns/123/status?api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "START"}'

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,
  "message": "Campaign status updated successfully",
  "campaign": {
    "id": 123,
    "status": "ACTIVE"
  }
}

Status Descriptions

StatusWhat It DoesReversible?
ACTIVEStarts sending emails according to scheduleYes
PAUSEDTemporarily stops all sendingYes
STOPPEDPermanently stops campaignNo
ARCHIVEDHides from active campaigns listYes
STOPPED status is permanent and cannot be undone. Use PAUSED if you might want to resume later.

When to Use Each Status

ACTIVE

  • Campaign is fully configured
  • All sequences added
  • Email accounts connected
  • Leads imported
  • Ready to send

PAUSED

  • Need to make adjustments
  • Waiting for more leads
  • Testing sequences
  • Temporary hold

STOPPED

  • Campaign completed its goal
  • Pivoting strategy
  • No longer needed
  • Permanently ending

ARCHIVED

  • Campaign is done but keep for records
  • Want to hide from active list
  • May reference later

Implementation Details

START status triggers campaign validation and begins sending. STOP is permanent. Use PAUSE for temporary holds. Response Format: object