---
title: "Archive a workflow"
method: POST
path: "/workflows/{workflow_id}/archive"
tags: ["Workflows"]
---

# Archive a workflow

`POST /workflows/{workflow_id}/archive`

## Request

- Base URL: `https://api.reacherapp.com/public/v1`
- URL: `https://api.reacherapp.com/public/v1/workflows/{workflow_id}/archive`
- Auth: API key in header `x-api-key` and API key in header `x-shop-id`

Retire the workflow: sending stops, its step automations stop, and it leaves the default list. Enrollments are not deleted, so the activity trail and per-step counts stay readable, but no creator advances again.

## Path parameters

- `workflow_id` string, required: The workflow's uuid, as `POST /workflows/list` returns it.

## Headers

- `Idempotency-Key` string, nullable

## Response `200`

Successful Response

- EnvelopeWorkflowStatusChangePublic
  - `data` WorkflowStatusChangePublic, required
    - `workflow_id` string, required
    - `status` string, required
    - `automations_updated` integer, required: Compiled engine rows this transition started or stopped.

## Other responses

- `400`: The document was rejected — an unreadable definition, an unknown step type, a daily limit above the ceiling, a non-HTTPS image URL — or the Idempotency-Key is missing or malformed.
- `403`: API key lacks `read_write` scope (`WRITE_NOT_PERMITTED`), or names a shop it is not granted.
- `404`: No such workflow in this shop.
- `409`: Idempotency conflict, or the workflow is not in a state that allows this transition.
- `422`: The request body is the wrong shape — an unknown top-level key, or a field of the wrong type.
- `429`: Write-tier rate limit (10/min, 50/hr, 100/day) exceeded.

## Changes

> 76 revisions in range; 1 not diffed.

- **2026-10-20** `9353ed4982e8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/reacherapp/apis/reacher-data-api/changes/workflows/:workflow_id/archive/post.md)

---

[API](https://skmtc.dev/reacherapp/apis/reacher-data-api.md) - [All operations](https://skmtc.dev/reacherapp/apis/reacher-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reacherapp/apis/reacher-data-api/revisions/63ce74b30b5a?raw)