Sign in

v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Update lead

This method allows updating a single lead. Pass an object to update a single lead.

patch/api/v4/leads/{id}

Path parameters

idinteger required

Lead ID

Headers

Content-Typestring

Request body

namestring

Lead name

pricenumber

Lead sale

status_idinteger

Stage ID the lead is added to, the first stage of the main pipeline by default.

pipeline_idinteger

Pipeline ID the lead is added to.

created_byinteger

The ID of the user creating the lead. When passing the value 0, the lead will be considered as created by the robot.

updated_byinteger

The ID of the user updating the lead. When passing the value 0, the lead will be considered as created by the robot.

created_atinteger

Lead creation date in the format of Unix Timestamp

updated_atinteger

Lead update date in the format of Unix Timestamp

closed_atinteger

Lead closure date in the format of Unix Timestamp

loss_reason_idinteger

Lead loss reason ID

responsible_user_idinteger

Lead responsible user ID

custom_fields_valuesstring json

An array of the current lead custom fields’ values

request_idstring

Field that will be returned unchanged in the response and will not be saved.

Response

200

Example response

{
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads"
    }
  },
  "_embedded": {
    "leads": [
      {
        "id": 152464,
        "updated_at": 1686732474,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/leads/152464"
          }
        }
      }
    ]
  }
}