---
title: "Archive a stream"
method: POST
path: "/v1/streams/{id}/archive"
tags: ["Streams"]
---

# Archive a stream

`POST /v1/streams/{id}/archive`

## Request

- Base URL: `https://api.sendora.se`
- URL: `https://api.sendora.se/v1/streams/{id}/archive`
- Auth: HTTP bearer

The stream takes no new messages from now on; what it already holds is still delivered, and its log and suppression list stay readable. An archived inbound stream refuses mail to its address, and the server may create another. Archiving an archived stream changes nothing. The default stream cannot be archived.

## Path parameters

- `id` string, uuid, required

## Response `200`

A stream of this server.

- object: A stream of this server.
  - `streamId` string, uuid, required: What a send names as streamId.
  - `kind` 'transactional' | 'broadcast' | 'inbound', required: transactional for mail the recipient expects; broadcast for mail to many; inbound for mail the server receives.
  - `name` string, required: The name given at creation, unique within the server.
  - `isDefault` boolean, required: The stream a send without a streamId goes on; one per server, transactional.
  - `createdAt` string, date-time, required
  - `archivedAt` string, date-time, nullable, required: Set once archived; the stream then takes no new messages.
  - `pausedAt` string, date-time, nullable, required: Set while Sendora has paused the stream after complaints; it takes no messages until support has resumed it.
  - `inboundAddress` string, nullable, required: The address of an inbound stream, its id on inbound.sendora.se; mail sent there is received on the stream. Null on every other kind.
  - `contentRetentionDays` integer, nullable, required: How many days an inbound stream keeps received content, 1 to 30; null means the default of 30. Null on every other kind.

## Other responses

- `401`: The key is missing, malformed or revoked.
- `403`: The key is of the other kind, or a connected app may not do this here: it is not for connections, the connection may only read here, or it is for test servers only.
- `404`: No such stream of this server.
- `409`: The default stream of a server cannot be archived.

---

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