Lebenszyklus

Die Lebenszyklus-Endpunkte verschieben eine Journey zwischen verschiedenen Zuständen. Übergeben Sie die Journey ID der Journey als uuid im Anfrage-Body. Der Aufruf gibt das aktualisierte Journey-Objekt zurück.

Eine Journey befindet sich immer in einem dieser Zustände:

Status	Bedeutung
`STATUS_DRAFT`	Wird bearbeitet. Verarbeitet keine Benutzer.
`STATUS_RUNNING`	Aktiv, verarbeitet Benutzer.
`STATUS_PAUSED`	Vorübergehend angehalten, kann fortgesetzt werden.
`STATUS_FINISHED`	Gestoppt, verarbeitet keine Benutzer mehr. Kann pausiert werden, um die Bearbeitung fortzusetzen, oder archiviert werden.
`STATUS_ARCHIVED`	Zur Speicherung archiviert. Endgültig – kann nicht über diese Endpunkte reaktiviert werden.

Endpunkte

Alle Lebenszyklus-Aufrufe verwenden denselben Anfrage-Body: Journey ID als uuid übergeben. Sie unterscheiden sich nur im Pfad:

Aktion	Methode & Pfad	Resultierender Zustand
Starten	`POST /api/v3/journeygateway/start`	`STATUS_RUNNING`
Pausieren	`POST /api/v3/journeygateway/pause`	`STATUS_PAUSED`
Beenden	`POST /api/v3/journeygateway/finish`	`STATUS_FINISHED`
Archivieren	`POST /api/v3/journeygateway/archive`	`STATUS_ARCHIVED`

Gültige Übergänge

Von	Nach	Über
`STATUS_DRAFT`	`STATUS_RUNNING`	Starten
`STATUS_RUNNING`	`STATUS_PAUSED`	Pausieren
`STATUS_PAUSED`	`STATUS_RUNNING`	Starten
`STATUS_RUNNING`	`STATUS_FINISHED`	Beenden
`STATUS_PAUSED`	`STATUS_FINISHED`	Beenden
`STATUS_FINISHED`	`STATUS_PAUSED`	Pausieren
`STATUS_FINISHED`	`STATUS_ARCHIVED`	Archivieren

Die Archivierung ist der einzige Schritt in dieser Tabelle, der nicht über die Lebenszyklus-Endpunkte rückgängig gemacht werden kann.

Anfrage

Feld	Erforderlich	Typ	Beschreibung
`uuid`	Ja	string	Journey ID der Journey, die überführt werden soll.

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

Die API validiert den aktuellen Zustand vor dem Übergang – siehe Tabelle oben. Zum Beispiel gibt das Starten einer archivierten Journey einen Fehler zurück, da die Archivierung keinen umgekehrten Übergang hat.

Anfragebeispiele

Eine Journey starten

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

Eine Journey pausieren

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

Antwort

Gibt das aktualisierte Journey-Objekt zurück: info, points und comments. Das Feld info.status spiegelt den neuen Zustand wider.

Antwortbeispiel

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

Die vollständige Feldliste finden Sie in der Referenz zum Journey-Objekt.