Leads
Update a Lead
Updates a lead, e.g. if the status changes.
PATCH
/
api
/
leads
/
{id}
/
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Path Parameters
id
integer
requiredA unique integer value identifying this lead.
Body
email
string | null
phone_number
string | null
metadata
any | null
status
enum<string>
UNKNOWN
- UnknownNEW
- NewOPEN
- OpenCLOSED
- ClosedCLOSED_INCOMPLETE
- Closed incompleteLOST
- LostSCHEDULE_COMPLETED
- Schedule completed
Available options:
UNKNOWN
, NEW
, OPEN
, CLOSED
, CLOSED_INCOMPLETE
, LOST
, SCHEDULE_COMPLETED
status_reason
UNKNOWN
- UnknownWEBHOOK
- WebhookMANUAL
- ManualCHAT
- Chat
Available options:
UNKNOWN
, WEBHOOK
, MANUAL
, CHAT
lead_type
integer | null
Response
200 - application/json
id
integer
requiredemail
string | null
phone_number
string | null
requiredmetadata
any | null
modified_time
string
requiredcreated_time
string
requiredstatus
enum<string>
UNKNOWN
- UnknownNEW
- NewOPEN
- OpenCLOSED
- ClosedCLOSED_INCOMPLETE
- Closed incompleteLOST
- LostSCHEDULE_COMPLETED
- Schedule completed
Available options:
UNKNOWN
, NEW
, OPEN
, CLOSED
, CLOSED_INCOMPLETE
, LOST
, SCHEDULE_COMPLETED
status_reason
UNKNOWN
- UnknownWEBHOOK
- WebhookMANUAL
- ManualCHAT
- Chat
Available options:
UNKNOWN
, WEBHOOK
, MANUAL
, CHAT
lead_type
integer | null