Жизненный цикл

Эндпоинты жизненного цикла переводят Journey между состояниями. Передайте Journey ID в качестве uuid в теле запроса. Вызов возвращает обновленный объект Journey.

Journey всегда находится в одном из этих состояний:

Статус	Значение
`STATUS_DRAFT`	Редактируется. Не обрабатывает пользователей.
`STATUS_RUNNING`	Активно, обрабатывает пользователей.
`STATUS_PAUSED`	Временно остановлено, может быть возобновлено.
`STATUS_FINISHED`	Остановлено, больше не обрабатывает пользователей. Может быть приостановлено для возобновления редактирования или заархивировано.
`STATUS_ARCHIVED`	Заархивировано для хранения. Конечное состояние — не может быть повторно активировано через эти эндпоинты.

Эндпоинты

Все вызовы жизненного цикла используют одно и то же тело запроса: Journey ID, переданный как uuid. Они различаются только путем:

Действие	Метод и путь	Итоговое состояние
Запустить	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
Приостановить	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
Завершить	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
Архивировать	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Допустимые переходы

Из	В	Через
`STATUS_DRAFT`	`STATUS_RUNNING`	Запустить
`STATUS_RUNNING`	`STATUS_PAUSED`	Приостановить
`STATUS_PAUSED`	`STATUS_RUNNING`	Запустить
`STATUS_RUNNING`	`STATUS_FINISHED`	Завершить
`STATUS_PAUSED`	`STATUS_FINISHED`	Завершить
`STATUS_FINISHED`	`STATUS_PAUSED`	Приостановить
`STATUS_FINISHED`	`STATUS_ARCHIVED`	Архивировать

Архивация — единственный шаг в этой таблице, который нельзя отменить через эндпоинты жизненного цикла.

Запрос

Поле	Обязательно	Тип	Описание
`uuid`	Да	string	Journey ID для изменения состояния.

{ "uuid": "11111111-2222-3333-4444-555555555555" }

API проверяет текущее состояние перед переходом — см. таблицу выше. Например, запуск заархивированного Journey вернет ошибку, так как для архивации нет обратного перехода.

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

Запустить Journey

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/start \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

Приостановить Journey

curl -X POST https://journey-api.svc-nue.pushwoosh.com/api/v3/journeygateway/pause \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "uuid": "11111111-2222-3333-4444-555555555555" }'

Ответ

Возвращает обновленный объект Journey: info, points и comments. Поле info.status отражает новое состояние.

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

{
  "info": {
    "uuid": "11111111-2222-3333-4444-555555555555",
    "title": "Welcome series",
    "status": "STATUS_RUNNING",
    "created_at": "2026-05-01T09:00:00Z",
    "updated_at": "2026-06-17T12:00:00Z",
    "params": { "application_code": "XXXXX-XXXXX" },
    "campaign_type": "TriggerBased"
  },
  "points": [],
  "comments": []
}

Полный список полей см. в справочнике по объекту Journey.

Связанные материалы

Создание и обновление

Запуск через API

Объект Journey