Update lead status
curl --request PATCH \
--url https://api.sendpilot.ai/v1/leads/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "MEETING_BOOKED",
"customLeadStatus": "INTERESTED",
"note": "Customer showed interest in demo"
}
'import requests
url = "https://api.sendpilot.ai/v1/leads/{id}/status"
payload = {
"status": "MEETING_BOOKED",
"customLeadStatus": "INTERESTED",
"note": "Customer showed interest in demo"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'MEETING_BOOKED',
customLeadStatus: 'INTERESTED',
note: 'Customer showed interest in demo'
})
};
fetch('https://api.sendpilot.ai/v1/leads/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sendpilot.ai/v1/leads/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'MEETING_BOOKED',
'customLeadStatus' => 'INTERESTED',
'note' => 'Customer showed interest in demo'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sendpilot.ai/v1/leads/{id}/status"
payload := strings.NewReader("{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sendpilot.ai/v1/leads/{id}/status")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/leads/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"leadId": "lead_123",
"status": "MEETING_BOOKED",
"message": "<string>"
}Leads
Update Lead Status
Set a lead outcome and/or CRM categorization.
PATCH
/
v1
/
leads
/
{id}
/
status
Update lead status
curl --request PATCH \
--url https://api.sendpilot.ai/v1/leads/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "MEETING_BOOKED",
"customLeadStatus": "INTERESTED",
"note": "Customer showed interest in demo"
}
'import requests
url = "https://api.sendpilot.ai/v1/leads/{id}/status"
payload = {
"status": "MEETING_BOOKED",
"customLeadStatus": "INTERESTED",
"note": "Customer showed interest in demo"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'MEETING_BOOKED',
customLeadStatus: 'INTERESTED',
note: 'Customer showed interest in demo'
})
};
fetch('https://api.sendpilot.ai/v1/leads/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sendpilot.ai/v1/leads/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'MEETING_BOOKED',
'customLeadStatus' => 'INTERESTED',
'note' => 'Customer showed interest in demo'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sendpilot.ai/v1/leads/{id}/status"
payload := strings.NewReader("{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sendpilot.ai/v1/leads/{id}/status")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sendpilot.ai/v1/leads/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"MEETING_BOOKED\",\n \"customLeadStatus\": \"INTERESTED\",\n \"note\": \"Customer showed interest in demo\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"leadId": "lead_123",
"status": "MEETING_BOOKED",
"message": "<string>"
}Requires
leads:write. Supply at least one of status or customLeadStatus.
- Settable
status:OPPORTUNITY,MEETING_BOOKED,DONE,UNSUBSCRIBED,IRRELEVANT. customLeadStatus:LEAD,INTERESTED,MEETING_BOOKED,MEETING_COMPLETE_NOT_CLOSED,CLOSED,WRONG_PERSON,NOT_INTERESTED,NO_RESPONSE.
MESSAGE_SENT cannot be set through this endpoint. DONE, UNSUBSCRIBED, and IRRELEVANT stop further campaign outreach and remain permitted by the REST lapsed-subscription policy.
note replaces existing notes; omit it to preserve them. Its maximum length is 1,000 characters. Use an Idempotency-Key for retries. MCP uses custom_status, while this REST endpoint uses customLeadStatus.Authorizations
API key for authentication (prefix: sp_live_ or sp_test_)
Path Parameters
Lead ID
Body
application/json
New status for the lead. Only outcome statuses can be set; statuses managed by the sequence engine are rejected.
Available options:
OPPORTUNITY, MEETING_BOOKED, DONE, UNSUBSCRIBED, IRRELEVANT Example:
"MEETING_BOOKED"
New custom lead status for CRM categorization
Available options:
LEAD, INTERESTED, MEETING_BOOKED, MEETING_COMPLETE_NOT_CLOSED, CLOSED, WRONG_PERSON, NOT_INTERESTED, NO_RESPONSE Example:
"INTERESTED"
Optional note/reason for status change
Maximum string length:
1000Example:
"Customer showed interest in demo"