Все методы

Полный список методов API. Колонка «Способ» показывает, каким запросом метод вызывается: изменяющие методы принимают только POST. Колонка «Право» — какое право ключа нужно, чтобы метод сработал; ключ аккаунта может всё.

Готовые файлы для клиента

• Спецификация OpenAPI — импортируется в Swagger, Insomnia, n8n и генераторы клиентов
• Коллекция Postman — подставьте свой ключ в переменную apikey и пробуйте

Аккаунт

Метод	Что делает	Способ	Право
/account/balance/get	Баланс аккаунта (метод первой очереди)	GET, POST	account:read
/account/get	Аккаунт, тариф и расход	GET, POST	account:read
/account/summary	Сводка: боты, проекты, цепочки, списки	GET, POST	account:read
/log/get	Журнал вызовов API	GET, POST	account:read

Подписчики

Метод	Что делает	Способ	Право
/subscriber/get	Карточка подписчика	GET, POST	subscribers:read
/subscriber/find	Поиск по имени, нику, коду или заметке	GET, POST	subscribers:read
/subscriber/list	Список подписчиков с фильтрами	GET, POST	subscribers:read
/subscriber/tag/list	Теги подписчика	GET, POST	subscribers:read
/subscriber/data/get	Переменные подписчика по цепочкам	GET, POST	subscribers:read
/subscriber/chat/get	Переписка с подписчиком	GET, POST	subscribers:read
/subscriber/chains/get	В каких цепочках находится подписчик	GET, POST	subscribers:read
/subscriber/create	Создать или обновить подписчика	POST	subscribers:write
/subscriber/update	Изменить имя, ник или заметку	POST	subscribers:write
/subscriber/tag/add	Добавить тег	POST	subscribers:write
/subscriber/tag/remove	Снять тег	POST	subscribers:write
/subscriber/data/set	Записать переменные подписчику	POST	subscribers:write
/subscriber/block	Заблокировать подписчика	POST	subscribers:write
/subscriber/unblock	Разблокировать подписчика	POST	subscribers:write
/subscriber/delete	Удалить подписчика из базы (метод первой очереди)	POST	subscribers:write

Отправка и запуск

Метод	Что делает	Способ	Право
/message/send	Отправить сообщение подписчику	POST	messages:send
/block/start	Запустить блок у подписчика	POST	chains:write
/chain/start	Запустить цепочку с первого шага	POST	chains:write
/chain/stop	Остановить цепочку у подписчика	POST	chains:write
/broadcast/send	Рассылка по сегменту	POST	messages:send
/broadcast/stop	Отменить запланированную рассылку	POST	messages:send
/message/next/clear	Отменить отложенный запуск следующего сообщения (метод первой очереди)	POST	chains:write

Списки

Метод	Что делает	Способ	Право
/list/all	Все списки аккаунта	GET, POST	lists:read
/list/rows/get	Строки списка	GET, POST	lists:read
/list/rows/find	Поиск строк по колонкам	GET, POST	lists:read
/list/create	Создать список	POST	lists:write
/list/row/add	Добавить строку	POST	lists:write
/list/rows/add	Добавить много строк	POST	lists:write
/list/row/edit	Изменить строку	POST	lists:write
/list/row/delete	Удалить строку или несколько	POST	lists:write
/list/clear	Очистить список	POST	lists:write

CRM

Метод	Что делает	Способ	Право
/crm/stage/list	Этапы воронки	GET, POST	crm:read
/crm/board	Доска: сколько клиентов на этапах	GET, POST	crm:read
/crm/stage/get	Этап и ответственный подписчика	GET, POST	crm:read
/crm/stage/subscribers	Подписчики одного этапа	GET, POST	crm:read
/crm/manager/list	Сотрудники, получающие заявки	GET, POST	crm:read
/crm/assignee/list	Ответственные	GET, POST	crm:read
/crm/stage/set	Перевести подписчика на этап	POST	crm:write
/crm/stage/create	Создать этап воронки	POST	crm:write
/crm/assignee/set	Назначить ответственного	POST	crm:write

Платежи

Метод	Что делает	Способ	Право
/payment/system/list	Подключённые платёжные системы	GET, POST	payments:read
/payment/status	Статус платежа	GET, POST	payments:read
/payment/list	Платежи за период	GET, POST	payments:read
/payment/link/create	Создать ссылку на оплату	POST	payments:write

Боты

Метод	Что делает	Способ	Право
/bot/list	Боты аккаунта	GET, POST	bots:read
/bot/count	Количество подписчиков бота (метод первой очереди)	GET, POST	bots:read
/group/list	Проекты (группы ботов)	GET, POST	bots:read
/chain/list	Цепочки и их коды	GET, POST	bots:read
/chain/steps	Шаги цепочки и блоки внутри них	GET, POST	bots:read
/stat/get	Статистика по дням	GET, POST	stats:read
/bot/generate/status	Ход генерации бота	GET, POST	bots:read
/bot/state/set	Включить или выключить бота	POST	bots:write
/bot/webhook/refresh	Переустановить вебхук бота	POST	bots:write
/bot/generate	Собрать бота нейросетью	POST	bots:write
/bot/export	Выгрузить проекты файлом	POST	bots:read
/bot/import	Загрузить проект из выгрузки	POST	bots:write
/file/upload	Загрузить файл в аккаунт	POST	files:write
/link/create	Создать короткую ссылку	POST	links:write
/link/list	Короткие ссылки и переходы	GET, POST	links:read
/lead/list	Заявки с виджетов и бот-лендингов	GET, POST	crm:read

Календарь

Метод	Что делает	Способ	Право
/webapp/list	Мини-приложения аккаунта	GET, POST	bots:read
/gcalendar/sync	Синхронизация с Google Календарём (метод первой очереди)	GET, POST	calendar:write
/calendar/add	Добавить приложение-календарь (метод первой очереди)	POST	calendar:write
/calendar/edit	Изменить приложение-календарь (метод первой очереди)	POST	calendar:write
/calendar/event/add	Записать клиента (метод первой очереди)	GET, POST	calendar:write
/calendar/check/busy	Проверить занятость времени (метод первой очереди)	GET, POST	calendar:read
/calendar/schedule/get	Записи календаря (метод первой очереди)	GET, POST	calendar:read
/calendar/schedule/delete	Удалить запись (метод первой очереди)	GET, POST	calendar:write
/webapp/delete	Удалить мини-приложение (метод первой очереди)	GET, POST	calendar:write
/webapp/calendar/schedule/get	Записи календаря (прежний адрес) (метод первой очереди)	GET, POST	calendar:read
/webapp/calendar/schedule/delete	Удалить запись (прежний адрес) (метод первой очереди)	GET, POST	calendar:write

Ключи и события

Метод	Что делает	Способ	Право
/key/scopes	Список всех прав	GET, POST	keys:read
/key/list	Ключи аккаунта	GET, POST	keys:read
/key/create	Создать ключ с правами	POST	keys:write
/key/edit	Изменить ключ	POST	keys:write
/key/revoke	Отозвать ключ	POST	keys:write
/hook/events	Список событий	GET, POST	hooks:read
/hook/list	Подписки на события	GET, POST	hooks:read
/hook/log	Журнал доставок	GET, POST	hooks:read
/hook/create	Подписаться на события	POST	hooks:write
/hook/edit	Изменить подписку	POST	hooks:write
/hook/delete	Удалить подписку	POST	hooks:write
/hook/test	Пробная доставка	POST	hooks:write

Каталог товаров

Метод	Что делает	Способ	Право
/catalog/get	Ссылка на каталог (метод первой очереди)	GET, POST	catalog:read
/catalog/item/create	Создать товар (метод первой очереди)	POST	catalog:write
/catalog/item/edit	Изменить товар (метод первой очереди)	POST	catalog:write
/catalog/item/delete	Удалить товар (метод первой очереди)	POST	catalog:write
/catalog/item/bulk/create	Создать товары массово (метод первой очереди)	POST	catalog:write
/catalog/item/bulk/edit	Изменить товары массово (метод первой очереди)	POST	catalog:write
/catalog/item/bulk/delete	Удалить товары массово (метод первой очереди)	POST	catalog:write
/catalog/items/delete	Удалить все товары (метод первой очереди)	POST	catalog:write

Прочее

Метод	Что делает	Способ	Право
/proxy	Запрос через зарубежный сервер (метод первой очереди)	GET, POST	proxy:use
/get	Проверка ключа (метод первой очереди)	GET, POST	account:read

---

Методы первой очереди

Пометка (метод первой очереди) стоит у методов, которые появились раньше остальных: каталог товаров, календарь, прокси, баланс, счётчик подписчиков, удаление подписчика. Они работают как работали, и менять в своих интеграциях ничего не нужно.

Отличий от новых методов два:

1. Формат ответа об ошибке у них прежний — поле Error без машинного кода. Новые методы отдают ещё и code, см. Ошибки.
2. Изменяющие методы календаря принимают и GET — так исторически сложилось.

Ключи с правами работают и с ними: право проверяется до вызова.