Actions12
Update Lead
AI-generatedSummary
Update a lead
Inputs
- leadId (required) — Identifier of the lead to update
- updates (required) — Array of update objects, each containing propertyName and value; use isSelect:true for dropdown fields
- additionalFields — Optional collection of extra fields to include in the request
- requestOptions — Additional request configuration such as timeout, proxy, or batch settings
Output shape
a single lead record
Returns the updated lead object; errors are signaled by HTTP status codes and an error payload
Examples
Example 1: Update email and status of a lead
leadId: cl123456789; updates: [{propertyName: "email", value: "new@example.com"}, {propertyName: "status", value: "qualified", isSelect: true}]
Example 2: Update a lead with a custom additional field and increased timeout
leadId: cl987654321; updates: [{propertyName: "phone", value: "+15551234567"}]; requestOptions: {timeout: 15000}
Example 3: Batch update multiple leads using additional batch settings
updates: [{propertyName: "tags", value: "beta"}]; requestOptions: {batching: {batchSize: 100, batchInterval: 500}}