Streams

Update a stream

The id stays. A new name must be free within the server. contentRetentionDays applies to an inbound stream only and sets how long received content is kept.

patch/v1/streams/{id}

Request

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

Path parameters

idstring uuid required

The stream id.

Request body

namestring

1 to 100 characters.

contentRetentionDaysinteger nullable

Days an inbound stream keeps received content, 1 to 30; null for the default of 30.

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.