Postmark
Postmark API

Message Streams

Manage transactional, broadcast and inbound message streams on a server.


List message streams

GET
https://api.postmarkapp.com
/message-streams

Lists the message streams on the server.

List message streams › query Parameters

MessageStreamType
​string · enum

Filter by stream type. Defaults to all types.

Enum values:
All
Transactional
Inbound
Broadcast
IncludeArchivedStreams
​boolean

Include archived streams in the result. Defaults to false.

Default: false

List message streams › Responses

The server's message streams.

A list of message streams.
TotalCount
​integer · required

Number of streams matching the request.

Example: 2
​MessageStream[] · required

Streams on the server.

Example: [{"ID":"transactional-dev","ServerID":123457,"Name":"My Dev Transactional Stream","Description":"This is my second transactional stream","MessageStreamType":"Transactional","CreatedAt":"2026-10-06T08:00:00-04:00","UpdatedAt":"2026-10-06T09:00:00-04:00","ArchivedAt":"2026-10-06T09:30:00-04:00","ExpectedPurgeDate":"2026-11-05T09:30:00-04:00","SubscriptionManagementConfiguration":{"UnsubscribeHandlingType":"None"}}]

Create a message stream

POST
https://api.postmarkapp.com
/message-streams

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

Details of the stream to create.
ID
​string · maxLength: 30 · required

Unique stream ID. Starts with a letter, up to 30 characters, must not start with pm-.

Example: transactional-dev
Name
​string · required

Stream name.

Example: My Dev Transactional Stream
MessageStreamType
​MessageStreamType · enum · required

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
Description
​string

Stream description. No HTML.

Example: This is my second transactional stream
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.

Create a message stream › Responses

The created stream.

A message stream.
ID
​string

Unique ID of the stream, used as MessageStream when sending.

Example: transactional-dev
ServerID
​integer

ID of the server the stream belongs to.

Example: 123457

Stream name.

Example: My Dev Transactional Stream
Description
​string

Stream description.

Example: This is my second transactional stream
MessageStreamType
​MessageStreamType · enum

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
CreatedAt
​string · date-time

Creation time.

Example: 2026-10-06T08:00:00-04:00
UpdatedAt
​string | null · date-time

Last update time.

Example: 2026-10-06T09:00:00-04:00
ArchivedAt
​string | null · date-time

Time the stream was archived, if archived.

Example: 2026-10-06T09:30:00-04:00
ExpectedPurgeDate
​string | null · date-time

Date an archived stream will be permanently deleted.

Example: 2026-11-05T09:30:00-04:00
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.


Get a message stream

GET
https://api.postmarkapp.com
/message-streams/{streamId}

Returns a stream by ID.

Get a message stream › path Parameters

streamId
​string · required

ID of the message stream (e.g. outbound, broadcast, inbound).

Get a message stream › Responses

The stream.

A message stream.
ID
​string

Unique ID of the stream, used as MessageStream when sending.

Example: transactional-dev
ServerID
​integer

ID of the server the stream belongs to.

Example: 123457

Stream name.

Example: My Dev Transactional Stream
Description
​string

Stream description.

Example: This is my second transactional stream
MessageStreamType
​MessageStreamType · enum

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
CreatedAt
​string · date-time

Creation time.

Example: 2026-10-06T08:00:00-04:00
UpdatedAt
​string | null · date-time

Last update time.

Example: 2026-10-06T09:00:00-04:00
ArchivedAt
​string | null · date-time

Time the stream was archived, if archived.

Example: 2026-10-06T09:30:00-04:00
ExpectedPurgeDate
​string | null · date-time

Date an archived stream will be permanently deleted.

Example: 2026-11-05T09:30:00-04:00
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.


Edit a message stream

PATCH
https://api.postmarkapp.com
/message-streams/{streamId}

Updates a stream's name, description or subscription management settings. The ID and type cannot be changed.

Edit a message stream › path Parameters

streamId
​string · required

ID of the message stream (e.g. outbound, broadcast, inbound).

Edit a message stream › Request Body

Fields to change. Omitted fields are left unchanged.
Name
​string

New stream name.

Example: Updated Dev Stream
Description
​string

New stream description.

Example: Updating my dev transactional stream
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.

Edit a message stream › Responses

The updated stream.

A message stream.
ID
​string

Unique ID of the stream, used as MessageStream when sending.

Example: transactional-dev
ServerID
​integer

ID of the server the stream belongs to.

Example: 123457

Stream name.

Example: My Dev Transactional Stream
Description
​string

Stream description.

Example: This is my second transactional stream
MessageStreamType
​MessageStreamType · enum

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
CreatedAt
​string · date-time

Creation time.

Example: 2026-10-06T08:00:00-04:00
UpdatedAt
​string | null · date-time

Last update time.

Example: 2026-10-06T09:00:00-04:00
ArchivedAt
​string | null · date-time

Time the stream was archived, if archived.

Example: 2026-10-06T09:30:00-04:00
ExpectedPurgeDate
​string | null · date-time

Date an archived stream will be permanently deleted.

Example: 2026-11-05T09:30:00-04:00
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.


Archive a message stream

POST
https://api.postmarkapp.com
/message-streams/{streamId}/archive

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

Archive a message stream › path Parameters

streamId
​string · required

ID of the message stream (e.g. outbound, broadcast, inbound).

Archive a message stream › Responses

The stream was archived.

Result of archiving a stream.
ID
​string · required

ID of the archived stream.

Example: transactional-dev
ServerID
​integer · required

ID of the server.

Example: 123457
ExpectedPurgeDate
​string · date-time · required

Date the archived stream will be permanently deleted unless unarchived.

Example: 2026-11-05T09:30:00-04:00

Unarchive a message stream

POST
https://api.postmarkapp.com
/message-streams/{streamId}/unarchive

Restores an archived stream, as long as it has not yet been purged.

Unarchive a message stream › path Parameters

streamId
​string · required

ID of the message stream (e.g. outbound, broadcast, inbound).

Unarchive a message stream › Responses

The restored stream.

A message stream.
ID
​string

Unique ID of the stream, used as MessageStream when sending.

Example: transactional-dev
ServerID
​integer

ID of the server the stream belongs to.

Example: 123457

Stream name.

Example: My Dev Transactional Stream
Description
​string

Stream description.

Example: This is my second transactional stream
MessageStreamType
​MessageStreamType · enum

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
CreatedAt
​string · date-time

Creation time.

Example: 2026-10-06T08:00:00-04:00
UpdatedAt
​string | null · date-time

Last update time.

Example: 2026-10-06T09:00:00-04:00
ArchivedAt
​string | null · date-time

Time the stream was archived, if archived.

Example: 2026-10-06T09:30:00-04:00
ExpectedPurgeDate
​string | null · date-time

Date an archived stream will be permanently deleted.

Example: 2026-11-05T09:30:00-04:00
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.