Skip to main content
POST
Update Lead

Overview

Asynchronous Endpoint: This endpoint queues the lead update for background processing and responds immediately. The actual outcome of the update will be sent via webhook callbacks configured in your Process.

Body Parameters

string
MongoDB ObjectId of the lead (required if not using referenceId)
string
External reference ID (requires projectId and processId)
string
Required when using referenceId
string
Required when using referenceId
object
Metadata object to merge with existing metadata
string
Update the lead’s name
string
Target state to transition the lead to (e.g., “interested”, “lost”, “followup_2”)
string
Disposition reason (used with targetState “interested” or “lost”)
string
User ID for audit logging
If metadata is not provided, all other fields (except leadId, referenceId, projectId, processId, targetState, name, disposition, userId) will be merged into metadata.

Response

boolean
Indicates if the update request was successfully accepted
string
Confirmation message (e.g., “Lead update initiated”)

Webhook Notifications

Once the asynchronous update job finishes processing, a webhook will be sent to the callback URLs configured in the Lead’s Process.
This payload is sent when the lead is successfully updated and transitioned (if requested).