Updates a lead's status (0=ACTIVE, 2=WON, 3=LOST, 5=XDATED) by `leadId`, optionally setting workflow, stage, date, loss reason, X-date type, source, recycle stage/pipeline, or tags; requires `date` and `xDateType` for status 5 (XDATED), and `lossReasonId` for status 3 (LOST).
datestringOptional. The relevant date associated with the status change. If status is XDATED (5), this is the reactivation date. Otherwise, it can be the contact or quoted date. Format: ISO 8601 string (e.g., YYYY-MM-DDTHH:mm:ssZ).
leadIdRequiredintegerThe unique identifier for the lead whose status is to be updated.
statusRequiredintegerThe new status for the lead. Allowed values are 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
tagIdsarrayOptional. A list of tag identifiers (integers) to be applied to or updated on the lead.
toStageIdintegerOptional. The identifier of the target workflow stage to move the lead to. This can be used for general stage movements.
xDateTypestringOptional. A descriptive name for the X-date recycle event (e.g., 'Renewal Reminder', 'Policy Expiration'). Used when `status` is 5 (XDATED) to specify the nature of the future follow-up.
workflowIdintegerOptional. Identifier of the workflow to associate with the lead.
lossReasonIdintegerOptional. The identifier for the reason a lead was lost, referencing an entry in the `leadLossReason` table. Typically used when `status` is 3 (LOST).
recycleToStageintegerOptional. The identifier of the stage to which the lead should be moved if it's being recycled.
workflowStageIdintegerOptional. Identifier of the specific stage within a workflow.
recycleToPipelineintegerOptional. The identifier of the pipeline to which the lead should be moved if it's being recycled.
changeLeadSourceTointegerOptional. The identifier for a new lead source, referencing an entry in the `leadSource` table. Use this to update 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.