Start campaign
Start a campaign that is in "draft" or "paused" status. The campaign must have:
- At least one mailbox assigned
- At least one sequence step
- At least one lead
Pending leads are automatically activated when the campaign starts.
curl -X POST "https://api.sendkit.ai/v1/campaigns/example_string/start" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.sendkit.ai/v1/campaigns/example_string/start"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
response = requests.post(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/campaigns/example_string/start", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("POST", "https://api.sendkit.ai/v1/campaigns/example_string/start", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/campaigns/example_string/start')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "665a1b2c3d4e5f6a7b8c9d0e",
"status": "active"
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Cannot start campaign with status: completed"
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Campaign must have at least one mailbox"
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Campaign must have at least one sequence step"
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Campaign must have at least one lead"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Campaign not found"
}
}
POST
/v1/campaigns/{campaignId}/startPOST
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
campaignIdstring
RequiredCampaign ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
campaignIdstring
RequiredCampaign ID
Responses
successboolean
dataobject
idstring
statusstring
Campaign cannot be started (wrong status, no mailboxes, no sequence, or no leads)
Campaign not found
Was this page helpful?
Last updated today
Built with Documentation.AI