leads_update
Update an existing lead's properties, including title, value, custom fields, or archive status. Send null to clear optional fields.
Instructions
Update an existing lead in Pipedrive.
Updates one or more properties of a lead. Only properties included in the request will be updated. Send null to unset a property (applicable for value, person_id, or organization_id).
Custom fields:
Pass display names: { "custom_fields": { "Source": "Web", "Budget": 5000 } }
Or hash keys directly: { "custom_fields": { "abc123...": "raw value" } }
Uses deal field definitions (leads share the deal custom fields).
Workflow tips:
Only include fields you want to update
Lead ID must be a UUID
Use null to clear optional fields
value must be an object with amount and currency
Leads inherit custom fields structure from deals
Set is_archived to true to archive a lead
Common use cases:
Update title: { "id": "", "title": "Updated Title" }
Update value: { "id": "", "value": { "amount": 10000, "currency": "USD" } }
Archive lead: { "id": "", "is_archived": true }
Clear person: { "id": "", "person_id": null }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | UUID of the lead to update (required) | |
| title | No | Lead title | |
| value | No | Lead value with amount and currency (null to clear) | |
| channel | No | Channel ID | |
| owner_id | No | ID of the user who will own this lead | |
| was_seen | No | Whether the lead was seen | |
| label_ids | No | Array of label UUIDs | |
| person_id | No | ID of the person associated with this lead (null to clear) | |
| channel_id | No | Channel identifier string | |
| visible_to | No | Visibility level | |
| is_archived | No | Whether the lead is archived | |
| custom_fields | No | Custom field values keyed by display name or hash. Uses deal field definitions. | |
| organization_id | No | ID of the organization associated with this lead (null to clear) | |
| expected_close_date | No | Expected close date in YYYY-MM-DD format |