Lifecycle

Este conteúdo ainda não está disponível no seu idioma.

The lifecycle endpoints move a journey between states. Pass the journey’s Journey ID as uuid in the request body. The call returns the updated journey object.

A journey is always in one of these states:

Status	Meaning
`STATUS_DRAFT`	Being edited. Does not process users.
`STATUS_RUNNING`	Active, processing users.
`STATUS_PAUSED`	Temporarily halted, can be resumed.
`STATUS_FINISHED`	Completed, no longer processing users.
`STATUS_ARCHIVED`	Archived for storage.

Endpoints

All lifecycle calls use the same request body: Journey ID passed as uuid. They differ only in the path:

Action	Method & path	Resulting state
Start	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
Pause	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
Finish	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
Draft	`POST /api/v3/journeygateway/draft`	`STATUS_DRAFT`
Archive	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Request

Field	Required	Type	Description
`uuid`	Yes	string	Journey ID of the journey to transition.

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

The API validates the current state before transitioning. For example, starting a journey that is already finished, or pausing one that is not running, returns an error.

Request examples

Start a 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" }'

Pause a 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" }'

Response

Returns the updated journey object: info, points, and comments. The info.status field reflects the new state.

Response example

{
  "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": []
}

See the journey object reference for the full field list.

Create and update

Start by API

Journey object