Воронки и этапы

В данном разделе описываются доступные методы для работы с воронками и этапами сделок

Общая информация
Список воронок сделок
Получение воронки сделок по ID
Добавление воронок
Редактирование воронки
Удаление воронки
Список статусов воронки сделок
Получение статуса воронки сделок по ID
Добавление статусов в воронку
Редактирование статуса воронки
Удаление статуса воронки
Доступные цвета статусов

Общая информация

В каждой воронке есть 3 системных статуса: Неразобранное, Успешно реализовано (ID = 142), Закрыто и не реализовано (ID = 143)
В аккаунте может быть не более 50 воронок.
В одной воронке может быть не более 100 статусов, включая системные.

Список воронок сделок

Метод

GET /api/v4/leads/pipelines

Описание

Метод позволяет получить список воронок сделок в аккаунте.

Ограничения

Метод доступен всем пользователям аккаунта.

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
401	Пользователь не авторизован

Параметры ответа

Метод возвращает коллекцию моделей воронок, рассмотрим ниже свойства воронки.

Параметр	Тип данных	Описание
id	int	ID воронки
name	string	Название воронки
sort	int	Сортировка воронки
is_main	bool	Является ли воронка главной
is_unsorted_on	bool	Включено ли неразобранное в воронке
is_archive	bool	Является ли воронка архивной
account_id	int	ID аккаунта, в котором находится воронка
_embedded[statuses]	array	Данные статусов, имеющихся в воронке. Подробней о статусах читайте ниже

Пример ответа

{
    "_total_items": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/pipelines"
        }
    },
    "_embedded": {
        "pipelines": [
            {
                "id": 3177727,
                "name": "Воронка",
                "sort": 1,
                "is_main": true,
                "is_unsorted_on": true,
                "is_archive": false,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727"
                    }
                },
                "_embedded": {
                    "statuses": [
                        {
                            "id": 32392156,
                            "name": "Неразобранное",
                            "sort": 10,
                            "is_editable": false,
                            "pipeline_id": 3177727,
                            "color": "#c1c1c1",
                            "type": 1,
                            "account_id": 12345678,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392156"
                                }
                            }
                        },
                        {
                            "id": 32392159,
                            "name": "Первичный контакт",
                            "sort": 20,
                            "is_editable": true,
                            "pipeline_id": 3177727,
                            "color": "#99ccff",
                            "type": 0,
                            "account_id": 12345678,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392159"
                                }
                            }
                        },
                        {
                            "id": 32392165,
                            "name": "Принимают решение",
                            "sort": 30,
                            "is_editable": true,
                            "pipeline_id": 3177727,
                            "color": "#ffcc66",
                            "type": 0,
                            "account_id": 12345678,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392165"
                                }
                            }
                        },
                        {
                            "id": 142,
                            "name": "Успешно реализовано",
                            "sort": 10000,
                            "is_editable": false,
                            "pipeline_id": 3177727,
                            "color": "#CCFF66",
                            "type": 0,
                            "account_id": 12345678,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/142"
                                }
                            }
                        },
                        {
                            "id": 143,
                            "name": "Закрыто и не реализовано",
                            "sort": 11000,
                            "is_editable": false,
                            "pipeline_id": 3177727,
                            "color": "#D5D8DB",
                            "type": 0,
                            "account_id": 12345678,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/143"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Получение воронки сделок по ID

Метод

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

Описание

Метод позволяет получить модель воронки сделок.

Ограничения

Метод доступен всем пользователям аккаунта.

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
401	Пользователь не авторизован

Параметры ответа

Метод возвращает модель воронки, рассмотрим ниже свойства воронки.

Параметр	Тип данных	Описание
id	int	ID воронки
name	string	Название воронки
sort	int	Сортировка воронки
is_main	bool	Является ли воронка главной
is_unsorted_on	bool	Включено ли неразобранное в воронке
is_archive	bool	Является ли воронка архивной
account_id	int	ID аккаунта, в котором находится воронка
_embedded[statuses]	array	Данные статусов, имеющихся в воронке. Подробней о статусах читайте ниже

Пример ответа

{
    "id": 3177727,
    "name": "Воронка",
    "sort": 1,
    "is_main": true,
    "is_unsorted_on": true,
    "is_archive": false,
    "account_id": 28847170,
    "_links": {
        "self": {
            "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727"
        }
    },
    "_embedded": {
        "statuses": [
            {
                "id": 32392156,
                "name": "Неразобранное",
                "sort": 10,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#c1c1c1",
                "type": 1,
                "account_id": 28847170,
                "_links": {
                    "self": {
                        "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392156"
                    }
                }
            },
            {
                "id": 32392159,
                "name": "Первичный контакт",
                "sort": 20,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#99ccff",
                "type": 0,
                "account_id": 28847170,
                "_links": {
                    "self": {
                        "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392159"
                    }
                }
            },
            {
                "id": 32392165,
                "name": "Принимают решение",
                "sort": 30,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#ffcc66",
                "type": 0,
                "account_id": 28847170,
                "_links": {
                    "self": {
                        "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392165"
                    }
                }
            },
            {
                "id": 142,
                "name": "Успешно реализовано",
                "sort": 10000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#CCFF66",
                "type": 0,
                "account_id": 28847170,
                "_links": {
                    "self": {
                        "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/142"
                    }
                }
            },
            {
                "id": 143,
                "name": "Закрыто и не реализовано",
                "sort": 11000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#D5D8DB",
                "type": 0,
                "account_id": 28847170,
                "_links": {
                    "self": {
                        "href": "https://shard152.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/143"
                    }
                }
            }
        ]
    }
}

Добавление воронок

Метод

POST /api/v4/leads/pipelines

Описание

Метод позволяет добавлять воронки в аккаунт пакетно.

Ограничения

Метод доступен только с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Параметр	Тип данных	Описание
name	string	Название воронки. Обязательный параметр
sort	int	Сортировка воронки. Обязательный параметр
is_main	bool	Является ли воронка главной. Обязательный параметр
is_unsorted_on	bool	Включено ли неразобранное в воронке. Обязательный параметр
_embedded[statuses]	array	Данные статусов, имеющихся в воронке. Вы можете передать названия для системных статусов 142 и 143 при создании воронки. Подробней о статусах читайте ниже
request_id	string	Поле, которое вернется вам в ответе без изменений и не будет сохранено. Необязательный параметр

Пример запроса

[
    {
        "name": "Воронка доп продаж",
        "is_main": false,
        "is_unsorted_on": true,
        "sort": 20,
        "request_id": "123",
        "_embedded": {
            "statuses": [
                {
                    "id": 142,
                    "name": "Мое название для успешных сделок"
                },
                {
                    "name": "Первичный контакт",
                    "sort": 10,
                    "color": "#fffeb2"
                }
            ]
        }
    }
]

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Воронки были успешно созданы
422	Переданные данные не могут быть обработаны. Подробности доступны в теле ответа
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает коллекцию воронок, которые были созданы. Параметры аналогичны тем, что возвращаются при запросе списка воронок.

Пример ответа

{
    "_total_items": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/pipelines"
        }
    },
    "_embedded": {
        "pipelines": [
            {
                "id": 3270358,
                "name": "Воронка для примера",
                "sort": 1,
                "is_main": true,
                "is_unsorted_on": false,
                "account_id": 1415131,
                "request_id": "123",
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270358"
                    }
                },
                "_embedded": {
                    "statuses": [
                        {
                            "id": 3304,
                            "name": "Неразобранное",
                            "sort": 10,
                            "is_editable": false,
                            "pipeline_id": 3270358,
                            "color": "#c1c1c1",
                            "type": 1,
                            "account_id": 1415131,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses/3304"
                                }
                            }
                        },
                        {
                            "id": 3303,
                            "name": "Первичный контакт",
                            "sort": 20,
                            "is_editable": true,
                            "pipeline_id": 3270358,
                            "color": "#fffeb2",
                            "type": 0,
                            "account_id": 1415131,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses/3303"
                                }
                            }
                        },
                        {
                            "id": 142,
                            "name": "Мое название для успешных сделок",
                            "sort": 10000,
                            "is_editable": false,
                            "pipeline_id": 3270358,
                            "color": "#CCFF66",
                            "type": 0,
                            "account_id": 1415131,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses/142"
                                }
                            }
                        },
                        {
                            "id": 143,
                            "name": "Закрыто и не реализовано",
                            "sort": 11000,
                            "is_editable": false,
                            "pipeline_id": 3270358,
                            "color": "#D5D8DB",
                            "type": 0,
                            "account_id": 1415131,
                            "_links": {
                                "self": {
                                    "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses/143"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Редактирование воронки

Метод

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

Описание

Метод позволяет редактировать воронку в аккаунте.

Ограничения

Метод доступен только с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

При редактировании воронки, необходимо передать хотя бы один параметр

Параметр	Тип данных	Описание
name	string	Название роли
sort	int	Сортировка воронки
is_main	bool	Является ли воронка главной
is_unsorted_on	bool	Включено ли неразобранное в воронке

Пример запроса

{
    "name": "Новое название для воронки",
    "is_main": false,
    "is_unsorted_on": false,
    "sort": 100
}

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Воронка была успешно изменена
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает модель воронки, которая были изменена. Параметры аналогичны тем, что возвращаются при запросе списка воронок.

Пример ответа

{
    "id": 3177727,
    "name": "Новое название для воронки",
    "sort": 1000,
    "is_main": false,
    "is_unsorted_on": false,
    "is_archive": false,
    "account_id": 12345678,
    "request_id": "0",
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727"
        }
    },
    "_embedded": {
        "statuses": [
            {
                "id": 32392159,
                "name": "Первичный контакт",
                "sort": 20,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#99ccff",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392159"
                    }
                }
            },
            {
                "id": 32392165,
                "name": "Принимают решение",
                "sort": 30,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#ffcc66",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392165"
                    }
                }
            },
            {
                "id": 142,
                "name": "Успешно реализовано",
                "sort": 10000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#CCFF66",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/142"
                    }
                }
            },
            {
                "id": 143,
                "name": "Закрыто и не реализовано",
                "sort": 11000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#D5D8DB",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/143"
                    }
                }
            }
        ]
    }
}

Удаление воронки

Метод

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

Описание

Метод позволяет удалить воронку в аккаунте.

Ограничения

Метод доступен только с правами администратора аккаунта
Нельзя удалить последнюю воронку в аккаунте
Нельзя удалить воронку, в которой есть сделки

Заголовок запроса

Content-Type: application/json

HTTP коды ответа

Код ответа	Условие
204	Воронка была успешно удалена
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод не возвращает тело

Список статусов воронки сделок

Метод

GET /api/v4/leads/pipelines/{pipeline_id}/statuses

Описание

Метод позволяет получить список статусов воронки сделок в аккаунте.

Ограничения

Метод доступен всем пользователям аккаунта.

GET параметры

Параметр	Тип данных	Описание
with	string	Данный параметр принимает строку, в том числе из нескольких значений, указанных через запятую. Данный метод поддерживает следующие параметры.

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
401	Пользователь не авторизован

Параметры ответа

Метод возвращает коллекцию моделей статусов, рассмотрим ниже свойства статуса.

Параметр	Тип данных	Описание
id	int	ID статуса
name	string	Название статуса
sort	int	Сортировка статуса
is_editable	bool	Доступен ли статус для редактирования
pipeline_id	int	ID воронки, в которой находится статус
color	string	Цвет статуса. Доступные цвета
type	int	Тип статуса (1 – неразобранное, 0 – обычный статус)
account_id	int	ID аккаунта, в котором находится воронка
descriptions	array	Требуется GET параметр with. Описания статуса
descriptions[0]	object	Модель описания статуса
descriptions[0][id]	int	ID описания статуса
descriptions[0][account_id]	int	ID аккаунта
descriptions[0][created_at]	string	Время создания статуса в формате YYYY-MM-DD HH:MM:SS
descriptions[0][updated_at]	string	Время последнего обновления статуса в формате YYYY-MM-DD HH:MM:SS
descriptions[0][created_by]	int	ID пользователя создавшего описание, 0 – апи
descriptions[0][updated_by]	int	ID пользователя обновившего описание, 0 – апи
descriptions[0][pipeline_id]	int	ID воронки описания статуса
descriptions[0][status_id]	int	ID статуса описания статуса
descriptions[0][level]	string	Уровень пользователей которым показывается описание статуса
descriptions[0][description]	string	Описание статуса

Пример ответа

{
    "_total_items": 5,
    "_embedded": {
        "statuses": [
            {
                "id": 32392156,
                "name": "Неразобранное",
                "sort": 10,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#c1c1c1",
                "type": 1,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392156"
                    }
                },
                "descriptions": []
            },
            {
                "id": 32392159,
                "name": "Первичный контакт",
                "sort": 20,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#99ccff",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392159"
                    }
                },
                "descriptions": [
                    {
                        "account_id": 12345678,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 12345,
                        "description": "Описание статуса \"Первичный контакт\" для новичка",
                        "id": 489,
                        "level": "newbie",
                        "pipeline_id": 3177727,
                        "status_id": 32392159,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": null
                    },
                    {
                        "account_id": 12345678,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 0,
                        "description": "Описание статуса \"Первичный контакт\" для кандидата",
                        "id": 491,
                        "level": "candidate",
                        "pipeline_id": 3177727,
                        "status_id": 32392159,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": 12345
                    },
                    {
                        "account_id": 12345678,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 123456,
                        "description": "Описание статуса \"Первичный контакт\" для мастера",
                        "id": 493,
                        "level": "master",
                        "pipeline_id": 3177727,
                        "status_id": 32392159,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": 123457
                    }
                ]
            },
            {
                "id": 32392165,
                "name": "Принимают решение",
                "sort": 30,
                "is_editable": true,
                "pipeline_id": 3177727,
                "color": "#ffcc66",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392165"
                    }
                },
                "descriptions": []
            },
            {
                "id": 142,
                "name": "Успешно реализовано",
                "sort": 10000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#CCFF66",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/142"
                    }
                },
                "descriptions": []
            },
            {
                "id": 143,
                "name": "Закрыто и не реализовано",
                "sort": 11000,
                "is_editable": false,
                "pipeline_id": 3177727,
                "color": "#D5D8DB",
                "type": 0,
                "account_id": 12345678,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/143"
                    }
                },
                "descriptions": []
            }
        ]
    }
}

Получение статуса воронки сделок по ID

Метод

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

Описание

Метод позволяет получить модель статуса воронки сделок в аккаунте по ID статуса.

Ограничения

Метод доступен всем пользователям аккаунта.

GET параметры

Параметр	Тип данных	Описание
with	string	Данный параметр принимает строку, в том числе из нескольких значений, указанных через запятую. Данный метод поддерживает следующие параметры.

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
401	Пользователь не авторизован

Параметры ответа

Метод возвращает модель статуса, рассмотрим ниже свойства статуса.

Параметр	Тип данных	Описание
id	int	ID статуса
name	string	Название статуса
sort	int	Сортировка статуса
is_editable	bool	Доступен ли статус для редактирования
pipeline_id	int	ID воронки, в которой находится статус
color	string	Цвет статуса. Доступные цвета
type	int	Тип статуса (1 – неразобранное, 0 – обычный статус)
account_id	int	ID аккаунта, в котором находится воронка
descriptions	array	Требуется GET параметр with. Описания статуса
descriptions[0]	object	Модель описания статуса
descriptions[0][id]	int	ID описания статуса
descriptions[0][account_id]	int	ID аккаунта
descriptions[0][created_at]	string	Время создания статуса в формате YYYY-MM-DD HH:MM:SS
descriptions[0][updated_at]	string	Время последнего обновления статуса в формате YYYY-MM-DD HH:MM:SS
descriptions[0][created_by]	int	ID пользователя создавшего описание, 0 – апи
descriptions[0][updated_by]	int	ID пользователя обновившего описание, 0 – апи
descriptions[0][pipeline_id]	int	ID воронки описания статуса
descriptions[0][status_id]	int	ID статуса описания статуса
descriptions[0][level]	string	Уровень пользователей которым показывается описание статуса
descriptions[0][description]	string	Описание статуса

Пример ответа

{
    "id": 32392159,
    "name": "Первичный контакт",
    "sort": 20,
    "is_editable": true,
    "pipeline_id": 3177727,
    "color": "#99ccff",
    "type": 0,
    "account_id": 12345678,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392159"
        }
    },
    "descriptions": [
        {
            "account_id": 12345678,
            "created_at": "2023-05-05 09:38:00",
            "created_by": 12345,
            "description": "Описание статуса \"Первичный контакт\" для новичка",
            "id": 489,
            "level": "newbie",
            "pipeline_id": 3177727,
            "status_id": 32392159,
            "updated_at": "2023-05-05 09:38:00",
            "updated_by": null
        },
        {
            "account_id": 12345678,
            "created_at": "2023-05-05 09:38:00",
            "created_by": 12345,
            "description": "Описание статуса \"Первичный контакт\" для кандидата",
            "id": 491,
            "level": "candidate",
            "pipeline_id": 3177727,
            "status_id": 32392159,
            "updated_at": "2023-05-05 09:38:00",
            "updated_by": 12345
        },
        {
            "account_id": 12345678,
            "created_at": "2023-05-05 09:38:00",
            "created_by": 12345,
            "description": "Описание статуса \"Первичный контакт\" для мастера",
            "id": 493,
            "level": "master",
            "pipeline_id": 3177727,
            "status_id": 32392159,
            "updated_at": "2023-05-05 09:38:00",
            "updated_by": 12345
        }
    ]
}

Параметры для GET-параметра with

Параметр	Описание
descriptions	Добавляет в ответ описания статуса

Добавление статусов в воронку

Метод

POST /api/v4/leads/pipelines/{pipeline_id}/statuses

Описание

Метод позволяет добавлять статусы воронки в аккаунт пакетно.
Можно передать описания статусов (опционально).
Существуют следующие ограничения для описаний статусов:

Можно создать только 3 описания статуса для разных уровней пользователя
Нельзя передавать один и тот же уровень в разных описаниях
Максимальная длинна описания 1000 символов
Можно передавать эмоджи в описаниях
Можно передавать следующие уровни в описаниях: newbie candidate master

Ограничения

Метод доступен только с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Параметр	Тип данных	Описание
name	string	Название статуса. Обязательный параметр
sort	int	Сортировка статуса. Обязательный параметр
color	string	Цвет статуса. Доступные цвета. Необязательный параметр
request_id	string	Поле, которое вернется вам в ответе без изменений и не будет сохранено. Необязательный параметр
descriptions	array	Описания статуса. Необязательный параметр
descriptions[0]	object	Модель описания статуса
descriptions[0][level]	string	Уровень пользователей для которых показывается описание статуса
descriptions[0][description]	string	Описание статуса

Пример запроса

[
    {
        "name": "Новый этап",
        "sort": 100,
        "color": "#fffeb2",
        "descriptions": [
            {
                "level": "newbie",
                "description": "Описание статуса \"Новый этап\" для новичка"
            },
            {
                "level": "candidate",
                "description": "Описание статуса \"Новый этап\" для кандидата"
            },
            {
                "level":"master",
                "description": "Описание статуса \"Новый этап\" для мастера"
            }
        ]
    },
    {
        "name": "Новый этап 2",
        "sort": 200,
        "color": "#fffeb2"
    }
]

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Статусы были успешно созданы
422	Переданные данные не могут быть обработаны. Подробности доступны в теле ответа
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает коллекцию статусов, которые были созданы. Параметры аналогичны тем, что возвращаются при запросе списка статусов.

Пример ответа

{
    "_total_items": 2,
    "_embedded": {
        "statuses": [
            {
                "id": 33035290,
                "name": "Новый этап",
                "sort": 60,
                "is_editable": true,
                "pipeline_id": 3270355,
                "color": "#fffeb2",
                "type": 0,
                "account_id": 1415131,
                "request_id": "0",
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270355/statuses/33035290"
                    }
                },
                "descriptions": [
                    {
                        "account_id": 1415131,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 0,
                        "description": "Описание статуса \"Новый этап\" для новичка",
                        "id": 495,
                        "level": "newbie",
                        "pipeline_id": 3270355,
                        "status_id": 33035290,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": null
                    },
                    {
                        "account_id": 1415131,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 0,
                        "description": "Описание статуса \"Новый этап\" для кандидата",
                        "id": 497,
                        "level": "candidate",
                        "pipeline_id": 3270355,
                        "status_id": 33035290,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": null
                    },
                    {
                        "account_id": 1415131,
                        "created_at": "2023-05-05 09:38:00",
                        "created_by": 0,
                        "description": "Описание статуса \"Новый этап\" для мастера",
                        "id": 499,
                        "level": "master",
                        "pipeline_id": 3270355,
                        "status_id": 33035290,
                        "updated_at": "2023-05-05 09:38:00",
                        "updated_by": null
                    }
                ]
            },
            {
                "id": 33035293,
                "name": "Новый этап 2",
                "sort": 70,
                "is_editable": true,
                "pipeline_id": 3270355,
                "color": "#fffeb2",
                "type": 0,
                "account_id": 1415131,
                "request_id": "1",
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3270355/statuses/33035293"
                    }
                },
                "descriptions": []
            }
        ]
    }
}

Редактирование статуса воронки

Метод

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

Описание

Метод позволяет редактировать статус воронки в аккаунте.
Можно передать описания статусов (опционально).
Существуют следующие ограничения для описаний статусов:

Можно создать только 3 описания статуса для разных уровней пользователя
Нельзя передавать один и тот же уровень в разных описаниях
Максимальная длинна описания 1000 символов
Можно передавать эмоджи в описаниях
Можно передавать следующие уровни в описаниях: newbie candidate master
Для редактирования описания надо передать id описания, уровень и новое описание
Для создания описания id передавать не надо
Для удаления описания надо передать id описания, уровень и не передавать описание

Ограничения

Метод доступен только с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

При редактировании статуса, необходимо передать хотя бы один параметр

Параметр	Тип данных	Описание
name	string	Название статуса
sort	int	Сортировка статуса
color	string	Цвет статуса. Доступные цвета
descriptions	array	Описания статуса. Необязательный параметр
descriptions[0]	object	Модель описания статуса
descriptions[0][id]	int	ID описания статуса. Необязательный параметр, если не передавать, то описание просто будет перезаписано
descriptions[0][level]	string	Уровень пользователей для которых показывается описание статуса
descriptions[0][description]	string	Описание статуса. Необязательный параметр

Пример запроса

{
    "name": "Новое название для статуса",
    "color": "#c1e0ff",
    "descriptions": [
        {
            "level": "newbie",
            "description": "Описание статуса \"Новое название для статуса\" для новичка"
        },
        {
            "id": 497,
            "level": "candidate",
            "description": "Новое описание статуса \"Новое название для статуса\" для кандидата"
        },
        {
            "id": 499,
            "level":"master"
        }
    ]
}

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Статус был успешно изменен
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод возвращает модель статуса, который были изменена. Параметры аналогичны тем, что возвращаются при запросе списка статусов.

Пример ответа

{
    "id": 32392165,
    "name": "Новое название для статуса",
    "sort": 20,
    "is_editable": true,
    "pipeline_id": 3177727,
    "color": "#c1e0ff",
    "type": 0,
    "account_id": 12345678,
    "request_id": "0",
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/leads/pipelines/3177727/statuses/32392165"
        }
    },
    "descriptions": [
        {
            "account_id": 12345678,
            "created_at": "2023-05-05 09:48:00",
            "created_by": 0,
            "description": "Описание статуса \"Новое название для статуса\" для новичка",
            "id": 501,
            "level": "newbie",
            "pipeline_id": 3177727,
            "status_id": 32392165,
            "updated_at": "2023-05-05 09:48:00",
            "updated_by": null
        },
        {
            "account_id": 12345678,
            "created_at": "2023-05-05 09:38:00",
            "created_by": 12345,
            "description": "Новое описание статуса \"Новое название для статуса\" для кандидата",
            "id": 497,
            "level": "candidate",
            "pipeline_id": 3177727,
            "status_id": 32392165,
            "updated_at": "2023-05-05 09:48:00",
            "updated_by": 0
        }
    ]
}

Удаление статуса воронки

Метод

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

Описание

Метод позволяет удалить статус в аккаунте.

Ограничения

Метод доступен только с правами администратора аккаунта
Сделки, который находятся в этапе – будут переведены в первый этап воронки

Заголовок запроса

Content-Type: application/json

HTTP коды ответа

Код ответа	Условие
204	Статус был успешно удален
403	Не хватает прав для вызова данного метода
401	Пользователь не авторизован
400	Переданы некорректные данные. Подробности доступны в теле ответа

Параметры ответа

Метод не возвращает тело

Доступные цвета статусов

Цвет	Номер цвета
	#fffeb2
	#fffd7f
	#fff000
	#ffeab2
	#ffdc7f
	#ffce5a
	#ffdbdb
	#ffc8c8
	#ff8f92
	#d6eaff
	#c1e0ff
	#98cbff
	#ebffb1
	#deff81
	#87f2c0
	#f9deff
	#f3beff
	#ccc8f9
	#eb93ff
	#f2f3f4
	#e6e8ea

Оглавление

Общая информация

Список воронок сделок

Метод

Описание

Ограничения

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Получение воронки сделок по ID

Метод

Описание

Ограничения

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Добавление воронок

Метод

Описание

Ограничения

Заголовок запроса

Параметры запроса

Пример запроса

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Редактирование воронки

Метод

Описание

Ограничения

Заголовок запроса

Параметры запроса

Пример запроса

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Удаление воронки

Метод

Описание

Ограничения

Заголовок запроса

HTTP коды ответа

Параметры ответа

Список статусов воронки сделок

Метод

Описание

Ограничения

GET параметры

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Получение статуса воронки сделок по ID

Метод

Описание

Ограничения

GET параметры

Заголовок типа данных при успешном результате

Заголовок типа данных при ошибке

HTTP коды ответа

Параметры ответа

Пример ответа

Параметры для GET-параметра with

Добавление статусов в воронку

Метод

Описание

Ограничения

Заголовок запроса

Параметры запроса

Пример запроса

Заголовок типа данных при успешном результате