Skip to main content
PATCH
Manually update a lead’s status. This is useful for marking leads as opportunities or not interested based on external information. You can update either the campaign status, custom lead status, or both in a single request.

Request

X-API-Key
string
required
Your API key
id
string
required
The lead ID
status
string
The campaign status for the lead. Options:
  • MEETING_BOOKED - Mark as meeting booked
  • OPPORTUNITY - Mark as a sales opportunity
  • NOT_INTERESTED - Mark as not interested
  • DONE - Mark as completed
customLeadStatus
string
The custom lead status for CRM categorization. Options:
  • LEAD - New lead (default)
  • INTERESTED - Lead has shown interest
  • MEETING_BOOKED - Meeting has been scheduled
  • MEETING_COMPLETE_NOT_CLOSED - Meeting completed but deal not closed
  • CLOSED - Deal closed/won
  • WRONG_PERSON - Wrong contact/person
  • NOT_INTERESTED - Lead is not interested
  • NO_RESPONSE - No response received
note
string
Optional note to add to the lead’s history
At least one of status or customLeadStatus must be provided. You can update both in a single request.

Response

success
boolean
Whether the update was successful
leadId
string
Lead identifier
status
string
The new status
message
string
Confirmation message
When a lead’s status is updated, a lead.updated webhook event will be sent to your registered webhook endpoints.

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Lead ID

Body

application/json
status
enum<string>
required

New status for the lead

Available options:
PENDING,
CONNECTION_SENT,
CONNECTION_ACCEPTED,
MESSAGE_SENT,
REPLY_RECEIVED,
DONE
note
string

Optional note for the status change

Response

Lead status updated

success
boolean
required
leadId
string
required
status
string
required
message
string
required