Streams

Archive a stream

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.

post/v1/streams/{id}/archive

Request

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

Path parameters

idstring uuid required

The stream id.

Response

A 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 required

The name given at creation, unique within the server.

isDefaultboolean required

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

createdAtstring date-time required
archivedAtstring date-time nullable required

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

pausedAtstring date-time nullable required

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

inboundAddressstring 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.

contentRetentionDaysinteger 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.

Changes

No recorded changes to this operation across all 1 revision of this API.