Updates a lead's lifecycle status (e.g., Active, Won, Lost, X-Dated) and can optionally manage its workflow, pipeline, stage, source, or associated tags.
datestringDate for the status change. If status is 5 (XDATED), this is the reactivation date (e.g., 'YYYY-MM-DD'); otherwise, it can be contact or quoted date.
leadIdRequiredintegerUnique identifier of the lead to be updated (path parameter).
statusRequiredintegerNew status for the lead: 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
tagIdsarrayList of tag IDs to associate with the lead.
toStageIdintegerID of a specific workflow stage for direct assignment, irrespective of recycling.
xDateTypestringType or reason for the X-date, used if status is 5 (XDATED) (e.g., a predefined X-date recycle event name).
workflowIdintegerIdentifier of the workflow to associate; if provided, the lead moves to this workflow.
lossReasonIdintegerIdentifier for the loss reason. Recommended if status is 3 (LOST).
recycleToStageintegerID of the stage to move the lead to if it is being recycled.
workflowStageIdintegerIdentifier of the stage within the specified workflow to move the lead to.
recycleToPipelineintegerID of the pipeline to move the lead to if it is being recycled.
changeLeadSourceTointegerIdentifier for a new lead source to assign, updating the lead's origin.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.