update_lead
Modify fields on an existing Kommo lead with a PATCH request; omitted fields stay unchanged and the updated lead is returned. Change stages with move_lead_stage or edit many leads in bulk.
Instructions
Update fields on an existing lead by sending fields as the body of a Kommo API v4 PATCH /leads/{id}. Returns the updated lead. Overwrites the given values; omitted fields are untouched. For a stage change prefer move_lead_stage; for several leads use bulk_update_leads.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | Yes | Raw Kommo v4 lead fields to change, passed through unchanged. Common keys: name (string), price (integer), status_id (stage ID), pipeline_id, responsible_user_id, custom_fields_values (array of {field_id, values: [{value}]}), _embedded.tags (full replacement list of {id}). Example: {"name": "Acme renewal", "price": 2000}. | |
| lead_id | Yes | Kommo lead ID (integer). Obtain it from list_leads or from the create_lead result. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Lead ID. | |
| name | No | Lead name. | |
| price | No | Lead budget. | |
| _links | No | HAL links as returned by Kommo (self, next, ...). | |
| group_id | No | ID of the responsible user's group. | |
| _embedded | No | Embedded tags, contacts and companies. | |
| closed_at | No | Closing time, Unix seconds, or null. | |
| status_id | No | Current stage ID. | |
| account_id | No | Kommo account ID. | |
| created_at | No | Creation time, Unix seconds. | |
| created_by | No | ID of the user who created it. | |
| is_deleted | No | Whether the lead is deleted. | |
| updated_at | No | Last update time, Unix seconds. | |
| updated_by | No | ID of the user who last updated it. | |
| pipeline_id | No | Pipeline ID. | |
| loss_reason_id | No | Loss reason ID, or null. | |
| closest_task_at | No | Next task deadline, Unix seconds, or null. | |
| responsible_user_id | No | ID of the responsible Kommo user. | |
| custom_fields_values | No | Custom field values in Kommo format: objects with field_id, field_code and values. |