Ciclo de vida

Los endpoints del ciclo de vida mueven un journey entre estados. Pase el ID de Journey del journey como uuid en el cuerpo de la solicitud. La llamada devuelve el objeto de journey actualizado.

Un journey siempre se encuentra en uno de estos estados:

Estado	Significado
`STATUS_DRAFT`	En edición. No procesa usuarios.
`STATUS_RUNNING`	Activo, procesando usuarios.
`STATUS_PAUSED`	Detenido temporalmente, se puede reanudar.
`STATUS_FINISHED`	Detenido, ya no procesa usuarios. Se puede pausar para reanudar la edición o archivarse.
`STATUS_ARCHIVED`	Archivado para almacenamiento. Terminal: no se puede reactivar a través de estos endpoints.

Endpoints

Todas las llamadas del ciclo de vida utilizan el mismo cuerpo de solicitud: el ID de Journey pasado como uuid. Solo difieren en la ruta:

Acción	Método y ruta	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`
Archivar	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Transiciones válidas

Desde	Hacia	Vía
`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`	Archivar

Archivar es el único paso en esta tabla que no se puede revertir a través de los endpoints del ciclo de vida.

Solicitud

Campo	Requerido	Tipo	Descripción
`uuid`	Sí	string	ID de Journey del journey a transicionar.

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

La API valida el estado actual antes de la transición; consulte la tabla anterior. Por ejemplo, iniciar un journey archivado devuelve un error, ya que el archivado no tiene una transición inversa.

Ejemplos de solicitud

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

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

Respuesta

Devuelve el objeto de journey actualizado: info, points y comments. El campo info.status refleja el nuevo estado.

Ejemplo de respuesta

{
  "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 la referencia del objeto de journey para ver la lista completa de campos.

Relacionado

Crear y actualizar

Iniciar por API

Objeto de Journey