---
title: "Mark guide as archived"
method: PUT
path: "/v1/users/{user_id}/guides/messages/archived"
tags: ["Guides", "Users"]
---

# Mark guide as archived

`PUT /v1/users/{user_id}/guides/messages/archived`

## Request

- Base URL: `https://api.knock.app`
- URL: `https://api.knock.app/v1/users/{user_id}/guides/messages/archived`
- Auth: HTTP bearer

Records that a guide has been archived by a user, triggering any associated archived events.

## Path parameters

- `user_id` string, required

## Request body

- GuideArchivedRequest: A request to mark a guide as archived.
  - `channel_id` string, uuid, required: The unique identifier for the channel.
  - `guide_id` string, uuid, required: The unique identifier for the guide.
  - `guide_key` string, required: The key of the guide.
  - `guide_step_ref` string, required: The step reference of the guide.
  - `is_final` boolean: Whether the guide is final.
  - `tenant` string: The tenant ID of the guide.
  - `unthrottled` boolean: Whether the guide bypasses its guide group's throttle settings. When true, archiving the guide does not open a new throttle window.

## Response `200`

OK

- GuideActionResponse: A response for a guide action.
  - `status` string, required: The status of a guide's action.

## Changes

- **2026-07-20** `512ce7e55eb6`: 1 breaking, 3 warning, 1 info
  - the request property `tenant` became not nullable
  - removed the request property `content`
  - removed the request property `data`
  - removed the request property `metadata`
  - …1 more
- **2025-09-22** `136d5581336a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/knocklabs/apis/knock-api/changes/v1/users/:user_id/guides/messages/archived/put.md)

---

[API](https://skmtc.dev/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.dev/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/knocklabs/apis/knock-api/revisions/dd3b76c7036d?raw)