Ciclo de vida

Os endpoints de ciclo de vida movem uma jornada entre estados. Passe o ID da Jornada da jornada como uuid no corpo da solicitação. A chamada retorna o objeto da jornada atualizado.

Uma jornada está sempre em um destes estados:

Status	Significado
`STATUS_DRAFT`	Sendo editada. Não processa usuários.
`STATUS_RUNNING`	Ativa, processando usuários.
`STATUS_PAUSED`	Temporariamente interrompida, pode ser retomada.
`STATUS_FINISHED`	Parada, não processa mais usuários. Pode ser pausada para retomar a edição ou arquivada.
`STATUS_ARCHIVED`	Arquivada para armazenamento. Terminal — não pode ser reativada através destes endpoints.

Endpoints

Todas as chamadas de ciclo de vida usam o mesmo corpo de solicitação: ID da Jornada passado como uuid. Elas diferem apenas no caminho:

Ação	Método e caminho	Estado resultante
Iniciar	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
Pausar	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
Finalizar	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
Arquivar	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Transições válidas

De	Para	Via
`STATUS_DRAFT`	`STATUS_RUNNING`	Iniciar
`STATUS_RUNNING`	`STATUS_PAUSED`	Pausar
`STATUS_PAUSED`	`STATUS_RUNNING`	Iniciar
`STATUS_RUNNING`	`STATUS_FINISHED`	Finalizar
`STATUS_PAUSED`	`STATUS_FINISHED`	Finalizar
`STATUS_FINISHED`	`STATUS_PAUSED`	Pausar
`STATUS_FINISHED`	`STATUS_ARCHIVED`	Arquivar

O arquivamento é o único passo nesta tabela que não pode ser revertido através dos endpoints de ciclo de vida.

Solicitação

Campo	Obrigatório	Tipo	Descrição
`uuid`	Sim	string	ID da Jornada da jornada a ser transicionada.

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

A API valida o estado atual antes da transição — veja a tabela acima. Por exemplo, iniciar uma jornada arquivada retorna um erro, já que o arquivamento não tem transição reversa.

Exemplos de solicitação

Iniciar uma jornada

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

Pausar uma jornada

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

Resposta

Retorna o objeto da jornada atualizado: info, points e comments. O campo info.status reflete o novo estado.

Exemplo de resposta

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

Consulte a referência do objeto da jornada para a lista completa de campos.

Relacionados

Criar e atualizar

Iniciar por API

Objeto da jornada