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

Эндпоинты жизненного цикла переводят 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/draft`	`STATUS_DRAFT`
Архивировать	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Запрос

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

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

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

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

Запустить Journey

curl -X POST https://journey.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.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": "Приветственная серия",
    "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