Update Lead

Updates a lead for limited fields

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Lead Update Request

Request body should contain either ref_id or cust_ref_id.

If both ref_id and cust_ref_id are passed, then the system will match both fields for finding the update record.

If a matching record is not found, the update request would generate a 400-Bad Request.

Allowed Update Fields

The update request should contain at least one of the following fields. System will try to update all the fields passed in the request

  1. phone: will be appended to existing phone numbers (if not already exists in the lead)
  2. email: will be appended to existing emails (if not already exists in the lead)
  3. owner: will modify the current owner (Sales Person) of the lead
  4. lead_status: Should be valid lead status slug
Body Params
string
required

Lead ref_id that uniquely identifies a lead

string
required

Lead cust_ref_id that was returned by the system when the original lead was created

string

The new phone number to be attached to the lead

string

The new email to be attached to the lead

string

Email of the Salesperson/owner

string

New Lead Status (should be valid slug)

string

Lead Disposition

string

Src detail

string

Src alias

string

UTM source

string

UTM medium

string

UTM campaign

string

UTM keyword

string

Dialer ID

string

Hardship

string
enum

TCPA Disclosure

Allowed:
string
enum
string
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json