Отправка триггера на сегмент

POST https://mailganer.com/api/v2/segments/{segment_id}/send_trigger/
{segment_id}— идентификатор сегмента, полученный при его создании в личном кабинете (например, 237916). Подставьте нужный ID сегмента в адрес запроса. Сегмент должен быть предварительно создан и настроен в личном кабинете. Отправка сработает, только если сегмент содержит условие «Список равен любому из».

API- метод запускает отправку указанного триггера всем подписчикам из заданного сегмента. Можно отправить триггер с учётом его внутренних условий ("Время отправки" и "Когда отправить") или игнорируя их (немедленная отправка без проверок).

Параметры запроса (передаются в теле JSON)

Структура ответа

Успешный запрос возвращает код 200 OK и JSON-объект следующего вида:
{
    "status": "success",
    "message": "Trigger sent successfully!",
    "data": {
        "segment_id": 2712311,
        "site_id": 1012348,
        "trigger_id": 13824,
        "ignore_conditions_and_time_send": true,
        "segment_name": "Тестовый сегмент",
        "trigger_name": "Тестовый триггер"
    }
}

Список параметров ответа (json)

Логика работы

  • Если ignore_trigger_conditions = false (или параметр опущен), триггер обрабатывается с учётом условий "Когда отправить" и "Время отправки", заданных в настройках триггера.
  • Если ignore_trigger_conditions = true, отправка выполняется сразу всем подписчикам без проверки каких-либо условий (кроме принадлежности сегменту и триггеру).
  • Актуальный список подписчиков определяется по текущему состоянию сегмента на момент запуска (пересчёт происходит автоматически).
  • Для предотвращения повторных массовых запусков действует внутреннее кэширование — повторный вызов для одного и того же сегмента игнорируется в течение 5 минут.
  • Отправка производится только тем подписчикам, чьи email-адреса находятся в статусе "Активен"

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

Отправка с учётом условий триггера (по умолчанию)
POST https://mailganer.com/api/v2/segments/27645611/send_trigger/
{
    "trigger_id": 34521
}
Отправка без учёта условий (немедленно)
POST https://mailganer.com/api/v2/segments/2734511/send_trigger/
{
    "trigger_id": 1345234,
    "ignore_trigger_conditions": true
}