Hoppa till innehållet

Menu

Streams

More ways to use this page

Archive a stream

POST/v1/streams/{id}/archive

TypeScript sendora.streams.archive(streamId)

Python sendora.streams.archive(stream_id)

Key sk_… a server key

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.

Parameters

  • idin pathstring (uuid)required

    The stream id.

Responses

200A stream of this server.

  • streamIdstring (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.

  • namestring (at least 1, at most 100 characters)required

    The name given at creation, unique within the server.

  • isDefaultbooleanrequired

    The stream a send without a streamId goes on; one per server, transactional.

  • createdAtstring (date-time)required
  • archivedAtstring (date-time) or nullrequired

    Set once archived; the stream then takes no new messages.

  • pausedAtstring (date-time) or nullrequired

    Set while Sendora has paused the stream after complaints; it takes no messages until support has resumed it.

  • inboundAddressstring or nullrequired

    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.

  • contentRetentionDaysinteger (1 to 30) or nullrequired

    How many days an inbound stream keeps received content, 1 to 30; null means the default of 30. Null on every other kind.

Example

{
  "streamId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "kind": "transactional",
  "name": "Notices",
  "isDefault": false,
  "createdAt": "2026-09-16T12:00:00.000Z",
  "archivedAt": "2026-09-16T13:00:00.000Z",
  "pausedAt": null,
  "inboundAddress": null,
  "contentRetentionDays": null
}

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

CodeStatusMeaning
unauthorized401The key is missing, malformed or revoked.
wrong_token_kind403The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.
not_found404No such stream of this server.
default_stream409The default stream of a server cannot be archived.