---
title: "Archive or restore a single capsule"
method: PATCH
path: "/api/preview/capsules/{id}/archive"
tags: ["capsule"]
---

# Archive or restore a single capsule

`PATCH /api/preview/capsules/{id}/archive`

## Path parameters

- `id` string, required — UUID v4 string

## Request body

- object
  - `archived` boolean, required — true to archive, false to restore

## Response `200`

Successful response

- object
  - `alreadyArchived` boolean, required
  - `attachmentCount` integer, required
  - `capsule` object, required
  - `durationMs` number, required
  - `inboundRefCount` integer, required
  - `ok` boolean, required
  - `revokedShareCount` integer, required

---

[API](https://skmtc.net/symbol/apis/symbol-api.md) · [All operations](https://skmtc.net/symbol/apis/symbol-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/symbol/symbol-api/revisions/c690ac22ae04/schema)