PATCH
/
api
/
leads
/
{id}
/

Authorizations

​
Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

A unique integer value identifying this lead.

Body

​
email
string | null
​
phone_number
string | null
Maximum length: 128
​
metadata
any | null
​
status
enum<string>
  • UNKNOWN - Unknown
  • NEW - New
  • OPEN - Open
  • CLOSED - Closed
  • CLOSED_INCOMPLETE - Closed incomplete
  • LOST - Lost
  • SCHEDULE_COMPLETED - Schedule completed
Available options:
UNKNOWN,
NEW,
OPEN,
CLOSED,
CLOSED_INCOMPLETE,
LOST,
SCHEDULE_COMPLETED
​
status_reason
  • UNKNOWN - Unknown
  • WEBHOOK - Webhook
  • MANUAL - Manual
  • CHAT - Chat
Available options:
UNKNOWN,
WEBHOOK,
MANUAL,
CHAT
​
lead_type
integer | null

Response

200 - application/json
​
id
integer
required
​
phone_number
string | null
required
Maximum length: 128
​
modified_time
string
required
​
created_time
string
required
​
email
string | null
​
metadata
any | null
​
status
enum<string>
  • UNKNOWN - Unknown
  • NEW - New
  • OPEN - Open
  • CLOSED - Closed
  • CLOSED_INCOMPLETE - Closed incomplete
  • LOST - Lost
  • SCHEDULE_COMPLETED - Schedule completed
Available options:
UNKNOWN,
NEW,
OPEN,
CLOSED,
CLOSED_INCOMPLETE,
LOST,
SCHEDULE_COMPLETED
​
status_reason
  • UNKNOWN - Unknown
  • WEBHOOK - Webhook
  • MANUAL - Manual
  • CHAT - Chat
Available options:
UNKNOWN,
WEBHOOK,
MANUAL,
CHAT
​
lead_type
integer | null
Retrieve a LeadUpdate a Lead with Phone / Email Match