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:
| Estado | Significado |
|---|---|
STATUS_DRAFT | Siendo editado. No procesa usuarios. |
STATUS_RUNNING | Activo, procesando usuarios. |
STATUS_PAUSED | Detenido temporalmente, se puede reanudar. |
STATUS_FINISHED | Completado, ya no procesa usuarios. |
STATUS_ARCHIVED | Archivado para almacenamiento. |
Endpoints
Anchor link toTodas las llamadas de ciclo de vida utilizan el mismo cuerpo de solicitud: ID del 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 |
| Borrador | POST /api/v3/journeygateway/draft | STATUS_DRAFT |
| Archivar | POST /api/v3/journeygateway/archive | STATUS_ARCHIVED |
Solicitud
Anchor link to| Campo | Requerido | Tipo | Descripción |
|---|---|---|---|
uuid | Sí | string | ID del Journey del journey a transicionar. |
{ "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 toIniciar un journey
Anchor link tocurl -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 tocurl -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" }'Respuesta
Anchor link toDevuelve 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.