> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracklysms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive Journey

> Archive an SMS welcome 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](/api-reference/authentication).

## Path Parameters

<ParamField path="journey_id" type="string" required>
  Journey ID returned by create or list. Use a valid journey ID; malformed IDs currently return an unexpected error.
</ParamField>

## 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](/api-reference/v2/journeys/get-journey) for the full definition.

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "message": "Journey archived successfully",
    "journey": {
      "id": "664f1a2b3c4d5e6f7a8b9c0d",
      "name": "Welcome",
      "priority": 0,
      "triggerSummary": "No trigger",
      "stepCount": 1,
      "enrolledCount": 0,
      "completedCount": 0,
      "status": "archived",
      "pauseReason": null,
      "createdAt": "2026-09-21T10:00:00",
      "updatedAt": "2026-09-21T10:00:00"
    }
  }
  ```
</ResponseExample>

Missing or foreign journeys return 404 with `error: "Journey not found"`.