---
title: "Update lead"
method: PATCH
path: "/api/v4/leads/{id}"
---

# Update lead

`PATCH /api/v4/leads/{id}`

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

## Path parameters

- `id` integer, required

## Headers

- `Content-Type` string

## Request body

- object
  - `name` string — Lead name
  - `price` number — Lead sale
  - `status_id` integer — Stage ID the lead is added to, the first stage of the main pipeline by default.
  - `pipeline_id` integer — Pipeline ID the lead is added to.
  - `created_by` integer — The ID of the user creating the lead. When passing the value 0, the lead will be considered as created by the robot.
  - `updated_by` integer — The ID of the user updating the lead. When passing the value 0, the lead will be considered as created by the robot.
  - `created_at` integer — Lead creation date in the format of Unix Timestamp
  - `updated_at` integer — Lead update date in the format of Unix Timestamp
  - `closed_at` integer — Lead closure date in the format of Unix Timestamp
  - `loss_reason_id` integer — Lead loss reason ID
  - `responsible_user_id` integer — Lead responsible user ID
  - `custom_fields_values` string, json — An array of the current lead custom fields’ values
  - `_embedded` object — Data of the tags added to a lead
    - `tags` object[]
      - `id` integer — Tag ID
      - `name` string — Tag name
  - `request_id` string — Field that will be returned unchanged in the response and will not be saved.
  - `tags_to_add` object[] — Array of tags to add. You need to pass either name or ID of the tag.
    - `id` integer — Tag ID
    - `name` string — Tag name
  - `tags_to_delete` object[] — Array of tags to delete. You need to pass either name or ID of the tag.
    - `id` integer — Tag ID
    - `name` string — Tag name

## Response `200`

200

- object
  - `_links` object
    - `self` object
      - `href` string
  - `_embedded` object
    - `leads` object[]
      - `id` integer
      - `updated_at` integer
      - `_links` object
        - `self` object
          - `href` string

## Other responses

- `400` — 400
- `401` — 401
- `429` — 429
- `500` — 500

---

[API](https://skmtc.net/kommo/apis/kommo-api-references.md) · [All operations](https://skmtc.net/kommo/apis/kommo-api-references/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kommo/kommo-api-references/versions/f17af4d23c7c/schema)