Cycle de vie

Les points de terminaison de cycle de vie déplacent un parcours entre différents états. Passez l’ID de Journey du parcours en tant que uuid dans le corps de la requête. L’appel renvoie l’objet de parcours mis à jour.

Un parcours se trouve toujours dans l’un de ces états :

Statut	Signification
`STATUS_DRAFT`	En cours d’édition. Ne traite pas les utilisateurs.
`STATUS_RUNNING`	Actif, traite les utilisateurs.
`STATUS_PAUSED`	Temporairement arrêté, peut être repris.
`STATUS_FINISHED`	Terminé, ne traite plus les utilisateurs.
`STATUS_ARCHIVED`	Archivé pour stockage.

Points de terminaison

Tous les appels de cycle de vie utilisent le même corps de requête : l’ID de Journey passé en tant que uuid. Ils ne diffèrent que par le chemin d’accès :

Action	Méthode et chemin d’accès	État résultant
Démarrer	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
Mettre en pause	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
Terminer	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
Mettre en brouillon	`POST /api/v3/journeygateway/draft`	`STATUS_DRAFT`
Archiver	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Requête

Champ	Requis	Type	Description
`uuid`	Oui	string	ID de Journey du parcours à faire transiter.

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

L’API valide l’état actuel avant la transition. Par exemple, démarrer un parcours qui est déjà terminé, ou mettre en pause un parcours qui n’est pas en cours d’exécution, renvoie une erreur.

Exemples de requêtes

Démarrer un parcours

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

Mettre un parcours en pause

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

Réponse

Renvoie l’objet de parcours mis à jour : info, points et comments. Le champ info.status reflète le nouvel état.

Exemple de réponse

{
  "info": {
    "uuid": "11111111-2222-3333-4444-555555555555",
    "title": "Série de bienvenue",
    "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": []
}

Consultez la référence de l’objet de parcours pour la liste complète des champs.

Sujets connexes

Créer et mettre à jour

Démarrer via l'API

Objet de parcours