patch https://{subdomain}.kommo.com/api/v4/leads/pipelines//statuses/
This method allows editing a pipeline stage. You can pass stage descriptions (optional).
Limitations
The method is available for administrator users only.
The following restrictions apply to stages descriptions:
- Only 3 stage descriptions can be created for different user levels
- You can not pass the same level in different descriptions
- Maximum description length 1000 characters
- You can send emojis in descriptions
- You can pass the following levels in descriptions: newbie, candidate and master
Authorization type
OAuth 2.0 with Access Token/ Long-lived token
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Response parameters
The method returns an object of the edited stage.
| Parameter | Data type | Description |
|---|---|---|
| name | string | Stage name |
| sort | int | Sequence number of the stage in the pipeline |
| color | string | Stage color |
| request_id | string | The field will be returned unchanged in the response and will not be saved. |
| descriptions | array | Stage descriptions array |
| descriptions[0] | object | Stage description object |
| descriptions[0][level] | string | Level of users the description is created for |
| descriptions[0][description] | string | Stage description |