Campaign Leads
Update campaign lead
Update a campaign lead's status or tags. Status can only be changed to "active" or "paused".
curl -X PATCH "https://api.sendkit.ai/v1/campaigns/example_string/leads/example_string" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"status": "paused",
"tags": [
"follow-up-later"
]
}'
import requests
import json
url = "https://api.sendkit.ai/v1/campaigns/example_string/leads/example_string"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"status": "paused",
"tags": [
"follow-up-later"
]
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/campaigns/example_string/leads/example_string", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"status": "paused",
"tags": [
"follow-up-later"
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"status": "paused",
"tags": [
"follow-up-later"
]
}`)
req, err := http.NewRequest("PATCH", "https://api.sendkit.ai/v1/campaigns/example_string/leads/example_string", 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/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"status": "paused",
"tags": [
"follow-up-later"
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"_id": "666a1b2c3d4e5f6a7b8c9d01",
"campaignId": "665a1b2c3d4e5f6a7b8c9d0e",
"status": "paused",
"tags": [
"follow-up-later"
],
"currentSequenceStep": 1,
"replied": false,
"addedAt": "2025-06-15T09:00:00.000Z"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Campaign lead not found"
}
}
PATCH
/v1/campaigns/{id}/leads/{leadId}PATCH
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
path
leadIdstring
RequiredCampaign lead record ID
Content-Typestring
RequiredThe media type of the request body
Options: application/json
statusstring
New status for the campaign lead
Options: active, paused
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
leadIdstring
RequiredCampaign lead record ID
Body
application/json
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI