Saltar al contenido

Ciclo de vida

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

Un journey siempre está en uno de estos estados:

EstadoSignificado
STATUS_DRAFTSiendo editado. No procesa usuarios.
STATUS_RUNNINGActivo, procesando usuarios.
STATUS_PAUSEDDetenido temporalmente, se puede reanudar.
STATUS_FINISHEDCompletado, ya no procesa usuarios.
STATUS_ARCHIVEDArchivado para almacenamiento.

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

AcciónMétodo y rutaEstado resultante
IniciarPOST /api/v3/journeygateway/startSTATUS_RUNNING
PausarPOST /api/v3/journeygateway/pauseSTATUS_PAUSED
FinalizarPOST /api/v3/journeygateway/finishSTATUS_FINISHED
BorradorPOST /api/v3/journeygateway/draftSTATUS_DRAFT
ArchivarPOST /api/v3/journeygateway/archiveSTATUS_ARCHIVED
CampoRequeridoTipoDescripción
uuidstringID del Journey del journey a transicionar.
Cuerpo
{ "uuid": "11111111-2222-3333-4444-555555555555" }

La API valida el estado actual antes de la transición. Por ejemplo, iniciar un journey que ya está finalizado, o pausar uno que no está en ejecución, devuelve un error.

Ejemplos de solicitud

Anchor link to

Iniciar un journey

Anchor link to
Terminal window
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" }'

Pausar un journey

Anchor link to
Terminal window
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" }'

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

Ejemplo de respuesta

Anchor link to
{
"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

Anchor link to