Skip to main content
PATCH
Update lead status
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.
Sequence-managed statuses such as 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

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Path Parameters

id
string
required

Lead ID

Body

application/json
status
enum<string>

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"

customLeadStatus
enum<string>

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"

note
string

Optional note/reason for status change

Maximum string length: 1000
Example:

"Customer showed interest in demo"

Response

Lead status updated

success
boolean
required

Success status

Example:

true

leadId
string
required

Lead ID

Example:

"lead_123"

status
string
required

New status

Example:

"MEETING_BOOKED"

message
string
required

Message