v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Edit pipeline

This method allows editing the pipeline on the account

patch/api/v4/leads/pipelines/{id}

Path parameters

idinteger required

Pipeline ID

Headers

Content-Typestring

Request header

Request body

namestring

Pipeline name

sortinteger

Sequence number of the pipeline in the pipeline list

is_mainboolean

Defines whether the pipeline is main for the account

is_unsorted_onboolean

Defines whether Incoming Leads are enabled

Response

200

idinteger

namestring

sortinteger

is_mainboolean

is_unsorted_onboolean

is_archiveboolean

account_idinteger

request_idstring

Example response

{
  "id": 6964299,
  "name": "New pipeline name",
  "sort": 100,
  "account_id": 31361463,
  "request_id": "0",
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads/pipelines/6964299"
    }
  },
  "_embedded": {
    "statuses": [
      {
        "id": 58220127,
        "name": "Initial contact",
        "sort": 20,
        "is_editable": true,
        "pipeline_id": 6964299,
        "color": "#fffeb2",
        "account_id": 31361463,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/leads/pipelines/6964299/statuses/58220127"
          }
        }
      }
    ]
  }
}