Campaign Leads
Bulk action on campaign leads
Perform bulk operations on leads within a campaign. Two selection modes:
Explicit IDs: Provide leadIds array with campaign lead record IDs.
Select all: Set selectAll: true with optional filters and excludeIds.
Available actions:
| Action | Description |
|---|---|
pause | Pause active leads (stops sending to them) |
resume | Resume paused leads (re-activates them) |
remove | Remove leads from campaign. Leads with no emails sent are hard-deleted; leads with email history are soft-deleted (status set to "removed") |
curl -X POST "https://api.sendkit.ai/v1/campaigns/example_string/leads/action" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"action": "pause",
"leadIds": [
"666a1b2c3d4e5f6a7b8c9d01",
"666a1b2c3d4e5f6a7b8c9d02"
]
}'
import requests
import json
url = "https://api.sendkit.ai/v1/campaigns/example_string/leads/action"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"action": "pause",
"leadIds": [
"666a1b2c3d4e5f6a7b8c9d01",
"666a1b2c3d4e5f6a7b8c9d02"
]
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/campaigns/example_string/leads/action", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"action": "pause",
"leadIds": [
"666a1b2c3d4e5f6a7b8c9d01",
"666a1b2c3d4e5f6a7b8c9d02"
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"action": "pause",
"leadIds": [
"666a1b2c3d4e5f6a7b8c9d01",
"666a1b2c3d4e5f6a7b8c9d02"
]
}`)
req, err := http.NewRequest("POST", "https://api.sendkit.ai/v1/campaigns/example_string/leads/action", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
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/leads/action')
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'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"action": "pause",
"leadIds": [
"666a1b2c3d4e5f6a7b8c9d01",
"666a1b2c3d4e5f6a7b8c9d02"
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"action": "pause",
"modifiedCount": 25
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Provide leadIds or selectAll"
}
}
POST
/v1/campaigns/{id}/leads/actionPOST
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
idstring
RequiredResource ID
Content-Typestring
RequiredThe media type of the request body
Options: application/json
No request body parameters defined
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_...)
header
Authorizationstring
RequiredBearer token. API key as Bearer token
Path Parameters
idstring
RequiredResource ID
Body
application/json
datastring
RequiredRaw application/json data
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI