Leads
Delete leads
Delete leads by explicit IDs or filter-based selection. Two modes:
By IDs: Provide leadIds array with one or more lead IDs.
Delete all: Set deleteAll: true with optional filters and excludeIds.
Leads in active campaigns are protected by default. The API returns a 400 error listing affected campaigns. Pass force: true to delete anyway — campaign leads are soft-removed (status set to "removed").
curl -X DELETE "https://api.sendkit.ai/v1/leads" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"leadIds": [
"665d4e5f6a7b8c9d0e1f2a3b",
"665d4e5f6a7b8c9d0e1f2a3c"
]
}'
import requests
import json
url = "https://api.sendkit.ai/v1/leads"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"leadIds": [
"665d4e5f6a7b8c9d0e1f2a3b",
"665d4e5f6a7b8c9d0e1f2a3c"
]
}
response = requests.delete(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/leads", {
method: "DELETE",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"leadIds": [
"665d4e5f6a7b8c9d0e1f2a3b",
"665d4e5f6a7b8c9d0e1f2a3c"
]
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"leadIds": [
"665d4e5f6a7b8c9d0e1f2a3b",
"665d4e5f6a7b8c9d0e1f2a3c"
]
}`)
req, err := http.NewRequest("DELETE", "https://api.sendkit.ai/v1/leads", 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/leads')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"leadIds": [
"665d4e5f6a7b8c9d0e1f2a3b",
"665d4e5f6a7b8c9d0e1f2a3c"
]
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"deletedCount": 5
}
}
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "3 lead(s) are in active campaigns: Q1 Outreach, Follow-up Campaign. Pass "force": true to delete anyway.",
"affectedLeads": 3,
"campaigns": [
"Q1 Outreach",
"Follow-up Campaign"
]
}
}
DELETE
/v1/leads
DELETE
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_...)
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
Body
application/json
datastring
RequiredRaw application/json data
Responses
successboolean
dataobject
Was this page helpful?
Last updated today
Built with Documentation.AI