v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Pipeline stage edit

This method allows editing a pipeline stage. You can pass stage descriptions (optional).

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

Path parameters

pipeline_idinteger required

Pipeline ID

idinteger required

Stage ID

Headers

Content-Typestring

Request header

Request body

namestring

Stage name

sortinteger

Sequence number of the stage in the pipeline

colorstring

Stage color

Response

200

idinteger
namestring
sortinteger
is_editableboolean
pipeline_idinteger
colorstring
typeinteger
account_idinteger
request_idstring

Example response

{
  "id": 58221923,
  "name": "New status name",
  "sort": 20,
  "is_editable": true,
  "pipeline_id": 6950551,
  "color": "#c1e0ff",
  "account_id": 31361463,
  "request_id": "0",
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58221923"
    }
  }
}