Документация API

REST API для уведомлений через Telegram и Max. Подписчики, OTP, рассылки, формы, helpdesk.

Разрешения подписчиков

Разрешения (permissions) — типы согласий подписчика. Один пользователь может быть подписан на «новости» и не подписан на «маркетинг». Рассылки фильтруются по разрешению, а подписчик может отказаться от конкретного типа, не отписываясь полностью.

Создание разрешения

Разрешение создаётся один раз на проект. key — машинный идентификатор, title — название для подписчика.

key string обязательный

Идентификатор: латиница, цифры, _

title string обязательный

Название для подписчика

POST /v1/permissions
{
"key": "marketing",
"title": "Маркетинговые рассылки"
}

Фильтр рассылок по разрешению

В /v1/broadcast укажите permission — сообщение уйдёт только подписчикам с этим разрешением (или тем, у кого разрешения не заданы вовсе).

POST /v1/broadcast
{
"text": "Скидка 20%",
"permission": "marketing"
}

Отказ от разрешения (opt-out)

Удаление разрешения у подписчика — частичная отписка. Подписчик перестаёт получать рассылки этого типа, но остаётся активным для остальных. Отправляется webhook subscription.permission_changed.

DELETE /v1/subscribers/{subscriber_id}/permissions/marketing

Массовое снятие — POST /v1/subscribers/{id}/permissions/bulk-remove с массивом keys. Текущие разрешения подписчика — GET /v1/subscribers/{id}/permissions.

Связанные разделы

Подписчики и теги
Получение списка, установка тегов, фильтрация по каналу и сегменту.
Управление проектом
Шаблоны, разрешения, теги, webhooks, авто-сообщения — CRUD через API.
Тестирование интеграции
Как тестировать интеграцию: test-ключи, dry-run, preview, проверка вебхуков.