Skip to main content
DELETE
Archive Journey
Sets the journey status to archived and releases existing holds on active enrollments. An archived journey sends nothing, and its released enrollments exit permanently as they come due; a later status change does not restore them. The journey remains available to list and read. Restricted keys may archive journeys when their scopes permit the operation. Declares the journeys.write scope. Authenticate with X-Api-Key; see Authentication.

Path Parameters

string
required
Journey ID returned by create or list. Use a valid journey ID; malformed IDs currently return an unexpected error.

Response

The compact journey object contains id, name, priority, triggerSummary, stepCount, enrolledCount, completedCount, status, pauseReason, createdAt, and updatedAt. It omits the account ID, trigger definition, and steps. Use Get Journey for the full definition.
Missing or foreign journeys return 404 with error: "Journey not found".