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

Этапы продаж – это последовательность шагов, которые проходит потенциальный клиент (сделка) по воронке продаж перед покупкой.
В amoCRM можно создавать несколько воронок продаж в одном аккаунте и задавать свои этапы для отслеживания хода сделки в каждой воронке.
В amoCRM можно настроить до 50-и воронок в аккаунте. Каждая воронка может содержать до 100 этапов (включая успешный и неуспешный статусы).
Настроить воронки и этапы продаж может администратор аккаунт на странице Настройки->Этапы продаж.

Методы для работы с настройками этапов продаж аккаунта доступны только администратору аккаунта. Методы для чтения доступны всем пользователям аккаунта.

Возможные параметры воронки

Параметр Тип Описание
id int Уникальный идентификатор воронки
name string Название воронки
sort int Порядок сортировки среди других воронок
is_main bool Является ли воронка основной.
В одном аккаунте может быть только одна основная воронка.
is_unsorted_on bool Включен ли этап “Неразобранное” для воронки
_embedded[statuses] array Массив, состоящий из этапов, созданных в воронке. Параметры этапов описаны ниже
account_id int Идентификатор аккаунта
request_id int Уникальный идентификатор запроса, необязательный параметр (информация о request_id нигде не сохраняется)

Возможные параметры этапов

Параметр Тип Описание
id int Уникальный идентификатор этапа
name string Название этапа
sort int Порядок сортировки среди других этапов
is_editable bool Возможность изменения параметров этапа
pipeline_id int Идентификатор воронки
color string Цвет этапа, который будет отображаться в интерфейсе воронки
Возможные значения: ‘#fffeb2’, ‘#fffd7f’, ‘#fff000’, ‘#ffeab2’, ‘#ffdc7f’, ‘#ffce5a’, ‘#ffdbdb’, ‘#ffc8c8’, ‘#ff8f92’, ‘#d6eaff’, ‘#c1e0ff’, ‘#98cbff’, ‘#ebffb1’, ‘#deff81’, ‘#87f2c0’, ‘#f9deff’, ‘#f3beff’, ‘#ccc8f9’, ‘#eb93ff’, ‘#f2f3f4’, ‘#e6e8ea’
type int Тип этапа
account_id int Идентификатор аккаунта

Список воронок

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

URL метода

GET /api/v4/leads/pipelines – для получения списка

GET /api/v4/leads/pipelines/{id:\d+} – для получения по идентификатору

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


GET https://example.amocrm.ru/api/v4/leads/pipelines

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


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

Создание воронки

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

URL метода

POST /api/v4/leads/pipelines

Этапы “Неразобранное”, “Успешно и реализовано” (142) и “Закрыто и не реализовано” (143) создаются всегда при создании новой воронки.

Обязательные параметры для создания воронки:
– name
– is_main
– is_unsorted_on
– sort
– _embedded[statuses]

Описание каждого из параметров можно посмотреть тут

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


GET https://example.amocrm.ru/api/v4/leads/pipelines
Параметр Тип Обязательность Описание
id int Не обязателен Идентификатор этапа.
Возможные значения:
– 142 (для успешно завершенных сделок),
– 143 (для неуспешно завершенных сделок)
name string Обязателен Название этапа
sort int Не обязателен Порядок сортировки относительно других этапов
color string Не обязателен Цвет этапа, который будет отображаться в интерфейсе воронки

Опционально можно передать с запросом параметр request_id.

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


POST https://example.amocrm.ru/api/v4/leads/pipelines
Content-Type: application/json

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

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


{
    "_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"
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

Изменение воронки

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

URL метода

PATCH /api/v4/leads/pipelines/{id:\d+}

Параметры доступные для изменения у воронки:
– name
– is_main
– is_unsorted_on
– sort

Описание каждого из параметров можно посмотреть тут

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


PATCH https://example.amocrm.ru/api/v4/leads/pipelines/3270358
Content-Type: application/json

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

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

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

URL метода

DELETE /api/v4/leads/pipelines/{id:\d+}

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


DELETE https://example.amocrm.ru/api/v4/leads/pipelines/3270358

При успешном удалении воронки, в ответ придет пустое тело и HTTP-код:

Response code: 204 (No Content);

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

Метод позволяет получить список этапов, созданных в воронке

URL метода

GET /api/v4/leads/pipelines/{pipeline_id:\d+}/statuses

Возможные параметры этапов описаны здесь.

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


GET https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses

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


{
    "_total_items": 4,
    "_embedded": {
        "statuses": [
            {
                "id": 33035131,
                "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/33035131"
                    }
                }
            },
            {
                "id": 33035134,
                "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/33035134"
                    }
                }
            },
            {
                "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"
                    }
                }
            }
        ]
    }
}

Получение этапа воронки

Метод позволяет получить этап из определенной воронки по его идентификатору

URL метода

GET /api/v4/leads/pipelines/{pipeline_id:\d+}/statuses/{id:\d+}

Возможные параметры этапов описаны здесь.

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


GET https://example.amocrm.ru/api/v4/leads/pipelines/3270358/statuses/33035134

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


{
    "id": 33035134,
    "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/33035134"
        }
    }
}

Добавление нового этапа в воронку

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

URL метода

POST /api/v4/leads/pipelines/{pipeline_id:\d+}/statuses

Обязательные параметры добавлении нового этапа:
– name
– sort
Опционально можно указать следующие параметры параметры:
– color
– request_id

Описание каждого из параметров можно найти тут.

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


POST https://example.amocrm.ru/api/v4/leads/pipelines/3270355/statuses
Content-Type: application/json

[
    {
        "name": "Новый этап",
        "sort": 100,
        "color": "#fffeb2"
    },
    {
        "name": "Новый этап 2",
        "sort": 200,
        "color": "#fffeb2"
    }
]

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


{
    "_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"
                    }
                }
            },
            {
                "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"
                    }
                }
            }
        ]
    }
}

Изменения параметров этапа воронки

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

URL метода

PATCH /api/v4/leads/pipelines/{pipeline_id:\d+}/statuses/{id:\d+}

Параметры доступные для изменения у этапа:
– name
– sort
– color

Описание каждого из параметров можно найти тут.

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


PATCH https://example.amocrm.ru/api/v4/leads/pipelines/3270355/statuses/33035293
Content-Type: application/json

{
    "name": "New name",
    "color": "#fff000",
    "sort": 1000
}

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


{
    "id": 33035293,
    "name": "New name",
    "sort": 20,
    "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/33035293"
        }
    }
}

Удаление этапа из воронки

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

URL метода

DELETE /api/v4/leads/pipelines/{pipeline_id:\d+}/statuses/{id:\d+}

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


DELETE https://example.amocrm.ru/api/v4/leads/pipelines/3270355/statuses/33035284

При успешном удалении этапа, в ответ придет пустое тело и HTTP-код:

Response code: 204 (No Content);

Смотрите также

КОДЫ ОШИБОК API