Update Lead Status

Updates the status and substatus of an existing lead. You can have status as OPEN (for new lead), WON (for a successful purchase lead), LOST (for unreverted lead), ON_HOLD, DELETED.

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

Body parameter

ParameterDescription
statusStatus for which you want to add sub-status.
subStatusName of the new sub-status that you want to create.
reasonIdReason id that you want to associate to the lead.
createdByEntity id of the staff who created the lead.
createdOnDate and time of lead creation in YYYY-MM-DDThh:mm:ssTZD format.

Response parameter

ParameterDescription
idUnique identifier for the lead.
userIdUser ID associated with the lead.
typeType of lead, e.g., SKU.
leadForLead for a specific item or SKU.
statusCurrent status of the lead.
nextFollowUpScheduled date and time for the next follow-up.
createdOnDate and time when the lead was created.
createdByUser ID of the creator of the lead.
lastUpdatedOnDate and time when the lead was last updated.
lastUpdatedByUser ID of the person who last updated the lead.
followUpDetailsDetails of follow-up activities for the lead.
statusLogDetailsDetails of the status log for the lead.
orgSourceIdOrganization source ID associated with the lead.
extendedFieldsExtended fields related to the lead.
subStatusSub-status of the lead.
warningsList of warnings associated with the response.
Body Params
string
enum
required

Status for which you want to add sub-status.

Allowed:
string

Name of the new sub-status that you want to create.

string
required

Reason id that you want to associate to the lead.

int64

Entity id of the staff who created the lead.

date

Date and time of lead creation in YYYY-MM-DDThh:mm:ssTZD format. Example: 2018-10-05T08:00:00+05:30

Response

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