Message Streams
Manage transactional, broadcast and inbound message streams on a server.
List message streams
Lists the message streams on the server.
query Parameters
MessageStreamTypeFilter by stream type. Defaults to all types.
IncludeArchivedStreamsInclude archived streams in the result. Defaults to false.
List message streams › Responses
The server's message streams.
TotalCountNumber of streams matching the request.
Streams on the server.
Create a message stream
Creates a Transactional or Broadcast stream on the server. A server can have only one Inbound stream, and stream limits depend on your plan.
Create a message stream › Request Body
IDUnique stream ID. Starts with a letter, up to 30 characters, must not start with pm-.
NameStream name.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
DescriptionStream description. No HTML.
Unsubscribe handling settings. Relevant to Broadcast streams.
Create a message stream › Responses
The created stream.
IDUnique ID of the stream, used as MessageStream when sending.
ServerIDID of the server the stream belongs to.
Stream name.
DescriptionStream description.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
CreatedAtCreation time.
UpdatedAtLast update time.
ArchivedAtTime the stream was archived, if archived.
ExpectedPurgeDateDate an archived stream will be permanently deleted.
Unsubscribe handling settings. Relevant to Broadcast streams.
Get a message stream
Returns a stream by ID.
path Parameters
streamIdID of the message stream (e.g. outbound, broadcast, inbound).
Get a message stream › Responses
The stream.
IDUnique ID of the stream, used as MessageStream when sending.
ServerIDID of the server the stream belongs to.
Stream name.
DescriptionStream description.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
CreatedAtCreation time.
UpdatedAtLast update time.
ArchivedAtTime the stream was archived, if archived.
ExpectedPurgeDateDate an archived stream will be permanently deleted.
Unsubscribe handling settings. Relevant to Broadcast streams.
Edit a message stream
Updates a stream's name, description or subscription management settings. The ID and type cannot be changed.
path Parameters
streamIdID of the message stream (e.g. outbound, broadcast, inbound).
Edit a message stream › Request Body
NameNew stream name.
DescriptionNew stream description.
Unsubscribe handling settings. Relevant to Broadcast streams.
Edit a message stream › Responses
The updated stream.
IDUnique ID of the stream, used as MessageStream when sending.
ServerIDID of the server the stream belongs to.
Stream name.
DescriptionStream description.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
CreatedAtCreation time.
UpdatedAtLast update time.
ArchivedAtTime the stream was archived, if archived.
ExpectedPurgeDateDate an archived stream will be permanently deleted.
Unsubscribe handling settings. Relevant to Broadcast streams.
Archive a message stream
Archives a stream. The stream is permanently deleted after ExpectedPurgeDate unless you unarchive it first. The default transactional and inbound streams cannot be archived (error code 1229).
path Parameters
streamIdID of the message stream (e.g. outbound, broadcast, inbound).
Archive a message stream › Responses
The stream was archived.
IDID of the archived stream.
ServerIDID of the server.
ExpectedPurgeDateDate the archived stream will be permanently deleted unless unarchived.
Unarchive a message stream
Restores an archived stream, as long as it has not yet been purged.
path Parameters
streamIdID of the message stream (e.g. outbound, broadcast, inbound).
Unarchive a message stream › Responses
The restored stream.
IDUnique ID of the stream, used as MessageStream when sending.
ServerIDID of the server the stream belongs to.
Stream name.
DescriptionStream description.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
CreatedAtCreation time.
UpdatedAtLast update time.
ArchivedAtTime the stream was archived, if archived.
ExpectedPurgeDateDate an archived stream will be permanently deleted.
Unsubscribe handling settings. Relevant to Broadcast streams.