Number of bounces to return per request.Max 500.Count + Offset cannot exceed 10000 bounces.

count

offset

type

Filter by emails that were deactivated by Postmark due to the bounce.Set to true or false. If this isn’t specified it will return both active and inactive.

inactive

emailFilter

messageID

Filter messages starting from the date/time specified (inclusive) e.g. 2021-01-01T12

fromdate

Filter messages up to the date/time specified (inclusive) e.g. 2021-01-01T12

todate

Filter by message stream ID. If not provided message will default to the outbound transactional stream.

messagestream

bounceid

Number of records to return per request.Max 500

example.com

A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net. For more information about this field please read our support page.

domainid

A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net.

Bcc recipient email address. Multiple addresses are comma separated. Max 50.
Subject

Cc recipient email address. Multiple addresses are comma separated. Max 50.

The sender email address. Must have a registered and confirmed Sender Signature.To include a name use the format "Full Name <sender@domain.com>" for the address.

If no TextBody specified HTML email message

Set message stream ID that's used for sending.If not provided message will default to the "outbound" transactional stream.

Reply To override email address.Defaults to the Reply To set in the sender signature. Multiple addresses are comma separated.

If no HtmlBody specified Plain text email message

Recipient email address.Multiple addresses are comma separated.Max 50.

Activate link tracking for links in the HTML or Text bodies of this email.Possible options; None HtmlAndText HtmlOnly TextOnly

The sender email address. Must have a registered and confirmed Sender Signature.To include a name use the format "Full Name <sender@domain.com>" for the address.
To

Email address (or domain) that you would like to block from sending.

triggeridtriggerid

stream_ID

Filters message streams based on stream type.Possible options; All Inbound Transactional Broadcasts.Defaults to All

MessageStreamType

Boolean filter for including archived message streams in list.Defaults to False.

IncludeArchivedStreams

My Dev Transactional Stream

The ID of the message stream being created.This is used when sending messages to specify the sending message stream

The type of message stream being created. Possible options Broadcasts Transasctional

Subscription management options for the Stream

The unsubscribe management option for the stream.For transactional streams default is None.For broadcast streams default is Postmark.Unsubscribe management is required for broadcast message streams approved accounts can use Custom.Possible options; none Postmark Custom.

Updated Dev Stream

The unsubscribe management option for the stream.For transactional streams default is None For broadcast streams default is Postmark. Unsubscribe management is required for broadcast message streams approved accounts can use Custom.Possible options

Number of messages to return per request. Max 500.Count + Offset cannot exceed 10000 messages

Number of messages to skip.Count + Offset cannot exceed 10000 messages

Filter by the user who was receiving the email

recipient

fromemail

Filter by status (queued or sent / processed).Note that sent and processed will return the same results and can be used interchangeably

status

Filter messages up to the date/time specified (inclusive). e.g. 2021-01-01T12

Filter messages starting from the date/time specified (inclusive)e.g. 2021-01-01T12

subject

Filter by message stream ID.If not provided message will default to the 'outbound' transactional stream

Filter by metadata value e.g. metadata_color.

metadata_

messageid

Number of messages to return per request.Max 500.Count + Offset cannot exceed 10000 messages

mailboxhash

Filter by status (blocked processed  queued failed scheduled)

Filter messages up to the date specified (inclusive).e.g. 2021-01-01T12

Filter messages starting from the date specified (inclusive).e.g. 2021-01-01T12

Bypass rules for a blocked inbound message

Retry a failed inbound message for processing

Filter by message stream ID.If not provided search will default to the outbound transactional stream

client_name

Filter by company i.e.Microsoft Apple Google

client_company

client_family

Filter by full OS name and specific version i.e. OS X 10.9 Mavericks Windows 7

os_name

Filter by kind of OS used without specific version i.e. OS X Windows

os_family

Filter by company which produced the OS i.e. Apple Computer Inc.Microsoft Corporation

os_company

Filter by platform i.e. webmail desktop mobile

platform

Filter by country messages were opened in i.e.Denmark Russia

country

Filter by full name of region messages were opened in i.e.Moscow New York

region

Filter by full name of city messages were opened in i.e.Minneapolis Philadelphia

city

Number of message opens to return per request. Max 500

Number of message clicks to return per request Max 500

Filter by company which produced the OS i.e. Apple Computer Inc.Microsoft Corporation
platform

Filter by country messages were clicked in i.e. Denmark Russia

Filter by full name of region messages were clicked in i.e. Moscow New York

Filter by full name of city messages were clicked in i.e. Minneapolis Philadelphia

Filter by message stream ID.If not provided message will default to the outbound transactional stream.

Number of message clicks to return per request.Max 500

John Doe

From email associated with sender signature

From name associated with sender signature

A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net

signatureid

A way to provide a note to the recipient of the confirmation email to have context of what Postmark is.Max length of 400 characters.

A custom value for the Return-Path domain.It is an optional field but it must be a subdomain of your From Email domain and must have a CNAME record that points to pm.mtasv.net.For more information about this field please read our support page

Production 2

URL to POST to every time a bounce event occurs

URL to POST to when a unique click event occurs

Color of the server in the rack screen.Purple Blue Turquoise Green Red Yellow Grey Orange

URL to POST to every time email is delivered

Specifies whether or not SMTP API Errors will be included with bounce webhooks.

URL to POST to every time an inbound event occurs

The maximum spam score for an inbound message before it's blocked

URL to POST to every time an open event occurs

If set to true only the first open by a particular recipient will initiate the open webhook.Any subsequent opens of the same email by the same recipient will not initiate the webhook.
TrackOpens

When enabled the raw email content will be included with inbound webhook payloads under the RawEmail key

Specifies whether or not SMTP is enabled on this server

Indicates if all emails being sent through this server should have link tracking enabled for links in their HTML or Text bodies.Possible options;None HtmlAndText HtmlOnly TextOnly

serverid

Color of the server in the server list for quick identification.Purple Blue Turquoise Green Red Yellow Grey Orange

If set to true only the first open by a particular recipient will initiate the open webhook.Any subsequent opens of the same email by the same recipient will not initiate the webhook

Indicates if all emails being sent through this server should have link tracking enabled for links in their HTML or Text bodies.Possible options; None HtmlAndText HtmlOnly TextOnly

Indicates if all emails being sent through this server have open tracking enabled

Staging Testing

Specifies the type of environment for your server.Possible options; Live Sandbox.Defaults to Live if not specified.This cannot be changed after the server has been created

Filter by a specific server name.Note that this is a string search so MyServer will match MyServer MyServer Production and MyServer Test.

name

Filter stats starting from the date specified (inclusive). e.g. 2014-01-01

Filter stats up to the date specified (inclusive). e.g. 2014-02-01

Filter by message stream.If not provided the response will include stats for all streams in the server.

Filter by message stream. If not provided the response will include stats for all streams in the server.

Filter by message stream. If not provided

the response will include stats for all streams in the server.

Filter stats up to the date specified (inclusive). e.g. 2014-02-01
messagestream

Filter by suppression reason. Possible options; HardBounce SpamComplaint ManualSuppression

SuppressionReason

Filter by origin of how the address was added to suppression list. Possible options; Recipient Customer Admin

Origin

Filter suppressions up to the date specified (inclusive) e.g. 2020-02-01

EmailAddress

The email address to request suppression creation on.

An ​array that will contain that email addresses to create a suppression on.Max of 50 suppressions that can be created in one call

The email address to request suppression deletion on.

An ​array of email addresses to delete a suppression on.Max of 50 suppressions that can be removed in one call

readme.txt

report.pdf

CUSTOM-HEADER

ACME

Bcc recipient email address.Multiple addresses are comma separated. Max 50

Cc recipient email address.Multiple addresses are comma separated. Max 50

The sender email address. Must have a registered and confirmed Sender Signature. To include a name use the format "Full Name <sender@domain.com>" for the address

Set message stream ID that's used for sending. If not provided

Reply To override email address.Defaults to the Reply To set in the sender signature

The alias of a template to use when sending this message.Required if TemplateId is not specified

The template to use when sending this message.Required if TemplateAlias is not specified

The model to be applied to the specified template to generate HtmlBody TextBody and Subject

Recipient email address.Multiple addresses are comma separated. Max 50

Bcc recipient email address.Multiple addresses are comma separated.Max 50

Cc recipient email address.Multiple addresses are comma separated.Max 50

The sender email address.Must have a registered and confirmed Sender Signature. To include a name use the format "Full Name <sender@domain.com>" for the address

Set message stream ID that's used for sending.If not provided message will default to the outbound transactional stream.

The list of templates to send.Please note that we accept up to 500 messages per API call

The template to use for this message.This value is required if TemplateId is not supplied.If both are supplied TemplateId will be used to select the template

The template to use for this message.This value is required if TemplateAlias is not supplied.If both are supplied TemplateId will be used to select the template

Activate link tracking for links in the HTML or Text bodies of this email.Possible options

Server ID of the destination server receiving the pushed templates

Specifies whether to push templates to destination server or not. This parameter can be set to false to allow you to do a "dry-run" of the push operation so that you can see which templates would be created or updated from this operation.

Server ID of the source server containing the templates that will be pushed

templateIdOrAlias

<html><body>Hello, {{name}}!</body></html>

Onboarding Email

Hello from {{company.name}}!

An optional string you can provide to identify this Template.Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter

The content to use for the HtmlBody when this template is used to send email.Required if TextBody is not specified.See our template language documentation for more information on the syntax for this field

An optional string to specify which Layout Template to use (via layout alias) for an existing Layout Template when creating a standard template.Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter.The API will throw an error if LayoutTemplate is present and the template type is a Layout. This field can also be set to null by using an empty string "".

The content to use for the TextBody when this template is used to send email. Required if HtmlBody is not specified. See our template language documentation for more information on the syntax for this field

An optional string you can provide to identify this template (if creating a standard template).Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter

The content to use for the HtmlBody when this template is used to send email.Required if TextBody is not specified.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present for a layout template and can be placed only once in the HtmlBody

An optional string to specify which Layout Template to use (via layout alias) for an existing Layout Template when creating a standard template Allowed characters are numbers ASCII letters and ‘.’ ‘-’ ‘_’ characters and the string has to start with a letter.The API will throw an error if LayoutTemplate is present and the template type is a Layout.This field can also be set to null by using an empty string "".

The content to use for the Subject when this template is used to send email.Subject is only required on standard templates.See our template language documentation for more information on the syntax for this field.Subjects are not allowed for layout templates and will result in an API error

Available when creating a template.To set if a template is standard template or layout template.Possible options; Standard or Layout.Defaults to Standard.After creation it's not possible to change a template type

The content to use for the TextBody when this template is used to send email. Required if HtmlBody is not specified. See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present for a layout template and can be placed only once in the TextBody

Count

The number of templates to "skip" before returning results

Offset

Filters templates based on template type (layout template or standard template).Possible options; All Standard Layout.Defaults to All

TemplateType

LayoutTemplate

The HTML body content to validate.Must be specified if TextBody or Subject are not.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present to validate a layout template and can be placed only once in the HtmlBody

When HtmlBody is specified the test render will have style blocks inlined as style attributes on matching html elements.You may disable the css inlining behavior by passing false for this parameter

An optional string to specify which layout template alias to use to validate a standard template.If not provided a standard template will not use a layout template.

The subject content to validate.Must be specified if HtmlBody or TextBody are not.See our template language documentation for more information on the syntax for this field

Validates templates based on template type (layout template or standard template).Possible options; Standard or Layout.Defaults to Standard

The template model to be used when rendering test content

The plain text body content to validate.Must be specified if Subject or HtmlBody are not.See our template language documentation for more information on the syntax for this field.A content placeholder is required to be present to validate a layout template and can be placed only once in the TextBody

Filter by message stream.If no stream is provided will return all webhooks for the server. If a non existing stream is provided an error is thrown instead of an empty webhooks array.

MessageStream

Listing for if the Bounce webhook is enabled/disabled.Webhook will send full bounce content if IncludeContent is enabled

Listing for if the Click webhook is enabled/disabled

Listing for if the Delivery webhook is enabled/disabled

The stream this webhook is associated with. If no MessageStream is provided the default transactional stream outbound will be used

Listing for if the Open webhook is enabled/disabled.Webhook will only post on first open if PostFirstOpenOnly is enabled

Listing for if the Spam webhook is enabled/disabled.Webhook will send full spam content if IncludeContent is enabled

Listing for if the Subscription Change webhook is enabled/disabled.

Featured

Others