Postmark

App · 20 actions

Send transactional email through Postmark, plainly or from templates, manage templates and layouts, search sent email with its opens and bounces, reactivate bounced addresses, manage suppressions, and read delivery statistics.

Actions

ActionWhat it does
Create templateCreate a template to send, or a layout other templates are placed inside.
Delete templateDelete a template or layout.
Get bounceRead one bounce: the address, the type and description, and whether it can be reactivated.
Get delivery statsCount the server's bounces by type, and the addresses Postmark is currently blocking.
Get sending statsTotals for the emails this server sent: sent, bounced, spam complaints, opens and clicks, with bounce and complaint rates.
Get sent emailRead one sent email in full: its bodies, recipients and everything that has happened to it since, including delivery, opens, clicks and bounces.
Get serverRead the connected server's settings: its name, delivery mode, tracking defaults and webhook URLs.
Get templateRead one template or layout in full: its subject, HTML and text bodies, alias and layout.
List bouncesList emails that bounced, newest first, with the reason and whether Postmark is now blocking the address.
List email opensList the times sent emails were opened, with the email client, platform and rough location.
List message streamsList the server's message streams (transactional, broadcast and inbound) with the id each one is referred to by.
List suppressionsList the addresses a message stream will not send to, and why: a hard bounce, a spam complaint, or added by hand.
List templatesList the server's templates and layouts, with each one's id, alias and type.
Reactivate bounceLet Postmark send to a bounced address again.
Remove suppressionsLet a message stream send to up to 50 suppressed addresses again.
Search sent emailsSearch the emails this server sent, newest first, by recipient, sender, tag, subject, status, stream, date or a metadata value.
Send emailSend one email through Postmark, with a text body, an HTML body or both, optional attachments, tracking, a tag and metadata.
Send email with templateSend one email built from a Postmark template, filling its {{variables}} from the values given.
Suppress addressesStop a message stream sending to up to 50 addresses.
Update templateChange a template's or layout's name, subject, bodies, alias or layout.

Create template

Create a template to send, or a layout other templates are placed inside. Bodies and subject can use {{variables}}. Returns the new template's id.

Inputs

NamenametextRequired
What to call it in Postmark.
Typetemplate_typetext
A template you send, or a layout. This cannot be changed later. Defaults to a template.One of: Standard (Template: an email you send), Layout (Layout: a shared wrapper templates are placed inside). Default: Standard.
Subjectsubjecttext
The subject line. Required for a template.Only when Type is Template: an email you send.
HTML bodyhtml_bodytext
The HTML version. A layout must contain {{{ @content }}} exactly once, where each template goes.
Text bodytext_bodytext
The plain-text version. Give this, the HTML body, or both.
Aliasaliastext
A name to refer to it by instead of its id: letters, digits, '.', '-' and '_', starting with a letter. A layout needs one for templates to use it.
Layoutlayouttext
The layout to place this template inside.Only when Type is Template: an email you send.

Outputs

Activetrue/false
Aliastext
LayoutTemplatetext
Nametext
TemplateIdnumber
TemplateTypetext
Example output
{
  "Active": true,
  "Alias": "onboarding-email",
  "LayoutTemplate": null,
  "Name": "Onboarding Email",
  "TemplateId": 1234,
  "TemplateType": "Standard"
}

Delete template

Delete a template or layout. A layout still used by templates cannot be deleted.

Inputs

TemplatetemplatetextRequired
The template or layout to delete.

Outputs

ErrorCodenumber
Messagetext
Templatetext
Example output
{
  "ErrorCode": 0,
  "Message": "Template 1234 removed.",
  "Template": "1234"
}

Get bounce

Read one bounce: the address, the type and description, and whether it can be reactivated.

Inputs

Bounce IDbounce_idtextRequired
The bounce's ID, from 'List bounces' or the bounce's page in Postmark.

Outputs

BouncedAttext
CanActivatetrue/false
Contenttext
Descriptiontext
Detailstext
DumpAvailabletrue/false
Emailtext
Fromtext
IDnumber
Inactivetrue/false
MessageIDtext
MessageStreamtext
Nametext
RecordTypetext
ServerIDnumber
Subjecttext
Tagtext
Typetext
TypeCodenumber
Example output
{
  "BouncedAt": "2026-10-14T03:52:19-04:00",
  "CanActivate": true,
  "Content": null,
  "Description": "The server was unable to deliver your message.",
  "Details": "action: failed",
  "DumpAvailable": true,
  "Email": "anything@blackhole.postmarkapp.com",
  "From": "sender@example.com",
  "ID": 692560173,
  "Inactive": true,
  "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
  "MessageStream": "outbound",
  "Name": "Hard bounce",
  "ServerID": 23,
  "Subject": "Hello from our app!",
  "Tag": "Invitation",
  "Type": "HardBounce",
  "TypeCode": 1
}

Get delivery stats

Count the server's bounces by type, and the addresses Postmark is currently blocking.

Inputs

None.

Outputs

Bounceslist
InactiveMailsnumber
Example output
{
  "Bounces": [
    {
      "Count": 253,
      "Name": "All"
    },
    {
      "Count": 195,
      "Name": "Hard bounce",
      "Type": "HardBounce"
    }
  ],
  "InactiveMails": 192
}

Get sending stats

Totals for the emails this server sent: sent, bounced, spam complaints, opens and clicks, with bounce and complaint rates. Leave the dates empty for all time.

Inputs

Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Message streammessage_streamtext
Only this message stream. Defaults to all.
Fromfrom_datedate
Start of the period.
Toto_datedate
End of the period.

Outputs

BounceRatenumber
Bouncednumber
Opensnumber
SMTPApiErrorsnumber
Sentnumber
SpamComplaintsnumber
SpamComplaintsRatenumber
TotalClicksnumber
TotalTrackedLinksSentnumber
Trackednumber
UniqueLinksClickednumber
UniqueOpensnumber
WithClientRecordednumber
WithLinkTrackingnumber
WithOpenTrackingnumber
WithPlatformRecordednumber
Example output
{
  "BounceRate": 10.406,
  "Bounced": 64,
  "Opens": 166,
  "SMTPApiErrors": 25,
  "Sent": 615,
  "SpamComplaints": 10,
  "SpamComplaintsRate": 1.626,
  "TotalClicks": 72,
  "TotalTrackedLinksSent": 60,
  "Tracked": 111,
  "UniqueLinksClicked": 30,
  "UniqueOpens": 26,
  "WithClientRecorded": 14,
  "WithLinkTracking": 90,
  "WithOpenTracking": 51,
  "WithPlatformRecorded": 10
}

Get sent email

Read one sent email in full: its bodies, recipients and everything that has happened to it since, including delivery, opens, clicks and bounces.

Inputs

Message IDmessage_idtextRequired
The id 'Send email' returned, or one from 'Search sent emails'.

Outputs

Attachmentslist
Bcclist
Bodytext
Cclist
Fromtext
HtmlBodytext
MessageEventslist
MessageIDtext
MessageStreamtext
Metadataobject
ReceivedAttext
Recipientslist
Sandboxedtrue/false
Statustext
Subjecttext
Tagtext
TextBodytext
Tolist
TrackLinkstext
TrackOpenstrue/false
Example output
{
  "Attachments": [],
  "Bcc": [],
  "Body": "",
  "Cc": [],
  "From": "\"Joe\" <joe@example.com>",
  "HtmlBody": "<p>Hello</p>",
  "MessageEvents": [
    {
      "Details": {
        "DeliveryMessage": "250 OK"
      },
      "ReceivedAt": "2026-10-14T10:59:01-04:00",
      "Recipient": "john.doe@example.com",
      "Type": "Delivered"
    }
  ],
  "MessageID": "0ac29aee-e1cd-480d-b08d-4f48548ff48d",
  "MessageStream": "outbound",
  "Metadata": {
    "color": "blue"
  },
  "ReceivedAt": "2026-10-14T10:58:58.9233386-04:00",
  "Recipients": [
    "john.doe@example.com"
  ],
  "Sandboxed": false,
  "Status": "Sent",
  "Subject": "staging",
  "Tag": "Invitation",
  "TextBody": "Hello",
  "To": [
    {
      "Email": "john.doe@example.com",
      "Name": null
    }
  ],
  "TrackLinks": "HtmlOnly",
  "TrackOpens": true
}

Get server

Read the connected server's settings: its name, delivery mode, tracking defaults and webhook URLs. Its API tokens are left out.

Inputs

None.

Outputs

BounceHookUrltext
ClickHookUrltext
Colortext
DeliveryHookUrltext
DeliveryTypetext
EnableSmtpApiErrorHookstrue/false
IDnumber
InboundAddresstext
InboundDomaintext
InboundHashtext
InboundHookUrltext
InboundSpamThresholdnumber
IncludeBounceContentInHooktrue/false
Nametext
OpenHookUrltext
PostFirstOpenOnlytrue/false
RawEmailEnabledtrue/false
ServerLinktext
SmtpApiActivatedtrue/false
TrackLinkstext
TrackOpenstrue/false
Example output
{
  "Color": "red",
  "DeliveryType": "Live",
  "ID": 1,
  "Name": "Staging Testing",
  "ServerLink": "https://account.postmarkapp.com/servers/1/streams",
  "SmtpApiActivated": true,
  "TrackLinks": "None",
  "TrackOpens": false
}

Get template

Read one template or layout in full: its subject, HTML and text bodies, alias and layout.

Inputs

TemplatetemplatetextRequired
The template or layout to read.

Outputs

Activetrue/false
Aliastext
AssociatedServerIdnumber
HtmlBodytext
LayoutTemplatetext
Nametext
Subjecttext
TemplateIdnumber
TemplateTypetext
TextBodytext
Example output
{
  "Active": true,
  "Alias": "onboarding-email",
  "AssociatedServerId": 1,
  "HtmlBody": "<p>Hello dear Postmark user. {{Name}}</p>",
  "LayoutTemplate": null,
  "Name": "Onboarding Email",
  "Subject": "Hi there, {{Name}}",
  "TemplateId": 1234,
  "TemplateType": "Standard",
  "TextBody": "Hello dear Postmark user. {{Name}}"
}

List bounces

List emails that bounced, newest first, with the reason and whether Postmark is now blocking the address.

Inputs

Bounce typebounce_typetext
Only bounces of this type.One of: HardBounce (Hard bounce), SoftBounce (Soft bounce), Transient, SpamComplaint (Spam complaint), SpamNotification (Spam notification), BadEmailAddress (Bad email address), Blocked, DnsError (DNS error), DMARCPolicy (DMARC policy), ManuallyDeactivated (Manually deactivated), and 12 more.
Address statusinactivetext
Only addresses Postmark is, or is not, blocking.One of: true (Only addresses Postmark is blocking), false (Only addresses Postmark still sends to).
Email addressemail_filtertext
Only bounces whose address contains this text.
Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Message IDmessage_idtext
Only the bounce of this sent email.
Message streammessage_streamtext
Only include this message stream. Defaults to outbound.
Fromfrom_datedate and time
Only include those on or after this moment.
Toto_datedate and time
Only include those on or before this moment.
Number of resultslimitnumber
How many to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many to skip first; use 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 9999. Default: 0.

Outputs

bounceslist
Bounces, newest first
countnumber
Records on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, or null
total_countnumber
How many records match, across every page
Example output
{
  "bounces": [
    {
      "BouncedAt": "2026-10-14T03:52:19-04:00",
      "CanActivate": true,
      "Content": null,
      "Description": "The server was unable to deliver your message.",
      "Details": "action: failed",
      "DumpAvailable": true,
      "Email": "anything@blackhole.postmarkapp.com",
      "From": "sender@example.com",
      "ID": 692560173,
      "Inactive": true,
      "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
      "MessageStream": "outbound",
      "Name": "Hard bounce",
      "RecordType": "Bounce",
      "ServerID": 23,
      "Subject": "Hello from our app!",
      "Tag": "Invitation",
      "Type": "HardBounce",
      "TypeCode": 1
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": null,
  "total_count": 1
}

List email opens

List the times sent emails were opened, with the email client, platform and rough location. Only emails sent with open tracking are recorded.

Inputs

Recipientrecipienttext
Only opens by this address.
Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Message streammessage_streamtext
Only include this message stream. Defaults to outbound.
Platformplatformtext
Only opens on this kind of platform.One of: webmail, desktop, mobile.
Email clientclient_nametext
Only opens in this client.
Email client familyclient_familytext
Only opens in this client family.
Operating systemos_nametext
Only opens on this operating system.
OS familyos_familytext
Only opens on this OS family.
Countrycountrytext
Only opens from this country.
Regionregiontext
Only opens from this region or state.
Citycitytext
Only opens from this city.
Number of resultslimitnumber
How many to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many to skip first; use 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 9999. Default: 0.

Outputs

countnumber
Records on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, or null
openslist
Opens, newest first
total_countnumber
How many records match, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": null,
  "opens": [
    {
      "Client": {
        "Company": "Google",
        "Family": "Gmail",
        "Name": "Gmail"
      },
      "Geo": {
        "City": "Boston",
        "Country": "United States"
      },
      "MessageID": "927e56d2-dc08-4de4-9cb5-e21dbd4e7d0f",
      "MessageStream": "outbound",
      "OS": {
        "Company": "Apple",
        "Family": "OS X",
        "Name": "OS X"
      },
      "Platform": "WebMail",
      "ReceivedAt": "2026-10-14T13:37:28-04:00",
      "Recipient": "john.doe@example.com",
      "RecordType": "Open",
      "Tag": "welcome-user",
      "UserAgent": "Mozilla/5.0"
    }
  ],
  "total_count": 1
}

List message streams

List the server's message streams (transactional, broadcast and inbound) with the id each one is referred to by.

Inputs

Typestream_typetext
Which kind to list. Defaults to all.One of: All (All streams), Transactional, Broadcasts, Inbound.
Include archivedinclude_archivedtrue/false
Also list archived streams.

Outputs

countnumber
message_streamslist
The server's message streams
total_countnumber
Example output
{
  "count": 1,
  "message_streams": [
    {
      "ArchivedAt": null,
      "CreatedAt": "2026-03-26T12:01:46.9574415-04:00",
      "Description": "This is my stream to send transactional messages",
      "ExpectedPurgeDate": null,
      "ID": "outbound",
      "MessageStreamType": "Transactional",
      "Name": "Transactional Stream",
      "ServerID": 123457,
      "SubscriptionManagementConfiguration": {
        "UnsubscribeHandlingType": "None"
      },
      "UpdatedAt": "2026-03-26T12:01:46.9574415-04:00"
    }
  ],
  "total_count": 1
}

List suppressions

List the addresses a message stream will not send to, and why: a hard bounce, a spam complaint, or added by hand.

Inputs

Message streammessage_streamtextRequired
Suppressions belong to one stream; outbound is the default transactional stream.
Reasonsuppression_reasontext
Only suppressions for this reason.One of: HardBounce (Hard bounce), SpamComplaint (Spam complaint), ManualSuppression (Added by hand).
Added byorigintext
Only suppressions added by this party.One of: Recipient (The recipient), Customer (You, through the app or the API), Admin (Postmark).
Email addressemail_addresstext
Only this address.
Fromfrom_datedate
Only those added on or after this.
Toto_datedate
Only those added on or before this.
Number of resultslimitnumber
How many to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many to skip first; use 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 9999. Default: 0.

Outputs

countnumber
Records on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, or null
suppressionslist
Suppressed addresses
total_countnumber
How many records match, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": null,
  "suppressions": [
    {
      "CreatedAt": "2026-10-10T08:58:33-04:00",
      "EmailAddress": "address@wildbit.com",
      "Origin": "Recipient",
      "SuppressionReason": "ManualSuppression"
    }
  ],
  "total_count": 1
}

List templates

List the server's templates and layouts, with each one's id, alias and type.

Inputs

Typetemplate_typetext
Which kind to list. Defaults to both.One of: All (Templates and layouts), Standard (Templates only), Layout (Layouts only).
Using layoutlayouttext
Only templates that use this layout.
Number of resultslimitnumber
How many to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many to skip first; use 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 9999. Default: 0.

Outputs

countnumber
Records on this page
has_moretrue/false
Whether another page follows
next_offsetnumber
The offset that reads the next page, or null
templateslist
Templates and layouts
total_countnumber
How many records match, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": null,
  "templates": [
    {
      "Active": true,
      "Alias": "onboarding-email",
      "LayoutTemplate": null,
      "Name": "Onboarding Email",
      "TemplateId": 1234,
      "TemplateType": "Standard"
    }
  ],
  "total_count": 1
}

Reactivate bounce

Let Postmark send to a bounced address again. Only bounces whose CanActivate is true can be reactivated; a spam complaint never can.

Inputs

Bounce IDbounce_idtextRequired
The bounce's ID, from 'List bounces' or the bounce's page in Postmark.

Outputs

Bounceobject
Messagetext
Example output
{
  "Bounce": {
    "BouncedAt": "2026-10-14T03:52:19-04:00",
    "CanActivate": true,
    "Content": null,
    "Description": "The server was unable to deliver your message.",
    "Details": "action: failed",
    "DumpAvailable": true,
    "Email": "anything@blackhole.postmarkapp.com",
    "From": "sender@example.com",
    "ID": 692560173,
    "Inactive": false,
    "MessageID": "2c1b63fe-43f2-4db5-91b0-8bdfa44a9316",
    "MessageStream": "outbound",
    "Name": "Hard bounce",
    "RecordType": "Bounce",
    "ServerID": 23,
    "Subject": "Hello from our app!",
    "Tag": "Invitation",
    "Type": "HardBounce",
    "TypeCode": 1
  },
  "Message": "OK"
}

Remove suppressions

Let a message stream send to up to 50 suppressed addresses again. Spam-complaint suppressions cannot be removed.

Inputs

Message streammessage_streamtextRequired
Suppressions belong to one stream; outbound is the default transactional stream.
Email addressesemail_addressestextRequired
Up to 50 addresses, separated by commas.

Outputs

Suppressionslist
Example output
{
  "Suppressions": [
    {
      "EmailAddress": "good.address@wildbit.com",
      "Message": null,
      "Status": "Deleted"
    }
  ]
}

Search sent emails

Search the emails this server sent, newest first, by recipient, sender, tag, subject, status, stream, date or a metadata value.

Inputs

Recipientrecipienttext
Only emails sent to this address.
Fromfrom_emailtext
Only emails sent from this address.
Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Subjectsubjecttext
Only emails with this subject.
Statusstatustext
Only emails still queued, or already sent.One of: queued, sent.
Message streammessage_streamtext
Only include this message stream. Defaults to outbound.
Fromfrom_datedate and time
Only include those on or after this moment.
Toto_datedate and time
Only include those on or before this moment.
Metadata namemetadata_keytext
Only emails whose metadata has this name...
Metadata valuemetadata_valuetext
...set to this value.
Number of resultslimitnumber
How many to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many to skip first; use 'next_offset' from a previous run to read the next page. Defaults to 0.From 0 to 9999. Default: 0.

Outputs

countnumber
Records on this page
has_moretrue/false
Whether another page follows
messageslist
Sent emails, newest first
next_offsetnumber
The offset that reads the next page, or null
total_countnumber
How many records match, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "messages": [
    {
      "Attachments": [],
      "Bcc": [],
      "Cc": [],
      "From": "\"Joe\" <joe@example.com>",
      "MessageID": "0ac29aee-e1cd-480d-b08d-4f48548ff48d",
      "MessageStream": "outbound",
      "Metadata": {
        "color": "blue"
      },
      "ReceivedAt": "2026-10-14T10:58:58.9233386-04:00",
      "Recipients": [
        "john.doe@example.com"
      ],
      "Sandboxed": false,
      "Status": "Sent",
      "Subject": "staging",
      "Tag": "Invitation",
      "To": [
        {
          "Email": "john.doe@example.com",
          "Name": null
        }
      ],
      "TrackLinks": "HtmlOnly",
      "TrackOpens": true
    }
  ],
  "next_offset": null,
  "total_count": 1
}

Send email

Send one email through Postmark, with a text body, an HTML body or both, optional attachments, tracking, a tag and metadata. Returns the message id Postmark assigned.

Inputs

Fromfrom_emailtextRequired
The sender. It must be a confirmed Sender Signature in Postmark, or an address on a domain you verified there. A name can go first: Jane Doe <jane@example.com>.
TototextRequired
Who receives it. Separate several addresses with commas; To, Cc and Bcc together can hold at most 50.
SubjectsubjecttextRequired
The subject line, up to 2,000 characters.
Text bodytext_bodytext
The plain-text version. Give this, the HTML body, or both.
HTML bodyhtml_bodytext
The HTML version. Give this, the text body, or both.
Cccctext
Addresses to copy, separated by commas.
Bccbcctext
Addresses to blind-copy, separated by commas.
Reply toreply_totext
Where replies go, if not to the From address.
Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Track openstrack_openstrue/false
Record when the email is opened. Leave unset to use the server's own setting.
Track linkstrack_linkstext
Record clicks on links in the email. Leave unset to use the server's own setting. Link tracking works once Postmark has approved the account.One of: None (Don't track links), HtmlAndText (Track in the HTML and text bodies), HtmlOnly (Track in the HTML body only), TextOnly (Track in the text body only).
Metadatametadataobject
Your own names and values to store with the email, such as an order number. They come back on searches, bounces and webhooks.
Custom headersheadersobject
Extra email headers, by name and value.
Attachmentsattachmentslist
Files to attach. Upload a file or reference a document (or a list of documents) from an earlier step. The whole email can be at most 10 MB.
Message streammessage_streamtext
The stream to send through. Defaults to the transactional stream, outbound.

Outputs

ErrorCodenumber
Messagetext
MessageIDtext
SubmittedAttext
Totext
Example output
{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0a129aee-e1cd-480d-b08d-4f48548ff48d",
  "SubmittedAt": "2026-10-15T12:16:12.6683391-04:00",
  "To": "receiver@example.com"
}

Send email with template

Send one email built from a Postmark template, filling its {{variables}} from the values given. Returns the message id.

Inputs

TemplatetemplatetextRequired
The template to send, picked or typed as an alias.
Template valuestemplate_modelobject
The values the template's {{variables}} are filled from, by variable name.
Fromfrom_emailtextRequired
The sender. It must be a confirmed Sender Signature in Postmark, or an address on a domain you verified there. A name can go first: Jane Doe <jane@example.com>.
TototextRequired
Who receives it. Separate several addresses with commas; To, Cc and Bcc together can hold at most 50.
Inline CSSinline_csstrue/false
Move the template's style rules onto each element, which some email clients need. Postmark does this by default.
Cccctext
Addresses to copy, separated by commas.
Bccbcctext
Addresses to blind-copy, separated by commas.
Reply toreply_totext
Where replies go, if not to the From address.
Tagtagtext
A label to group this email under in Postmark's statistics and searches.
Track openstrack_openstrue/false
Record when the email is opened. Leave unset to use the server's own setting.
Track linkstrack_linkstext
Record clicks on links in the email. Leave unset to use the server's own setting. Link tracking works once Postmark has approved the account.One of: None (Don't track links), HtmlAndText (Track in the HTML and text bodies), HtmlOnly (Track in the HTML body only), TextOnly (Track in the text body only).
Metadatametadataobject
Your own names and values to store with the email, such as an order number. They come back on searches, bounces and webhooks.
Custom headersheadersobject
Extra email headers, by name and value.
Attachmentsattachmentslist
Files to attach. Upload a file or reference a document (or a list of documents) from an earlier step. The whole email can be at most 10 MB.
Message streammessage_streamtext
The stream to send through. Defaults to the transactional stream, outbound.

Outputs

ErrorCodenumber
Messagetext
MessageIDtext
SubmittedAttext
Totext
Example output
{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0a129aee-e1cd-480d-b08d-4f48548ff48d",
  "SubmittedAt": "2026-10-15T12:16:12.6683391-04:00",
  "To": "receiver@example.com"
}

Suppress addresses

Stop a message stream sending to up to 50 addresses. Fails, naming each one, if Postmark refuses any of them.

Inputs

Message streammessage_streamtextRequired
Suppressions belong to one stream; outbound is the default transactional stream.
Email addressesemail_addressestextRequired
Up to 50 addresses, separated by commas.

Outputs

Suppressionslist
Example output
{
  "Suppressions": [
    {
      "EmailAddress": "good.address@wildbit.com",
      "Message": null,
      "Status": "Suppressed"
    }
  ]
}

Update template

Change a template's or layout's name, subject, bodies, alias or layout. Anything left empty stays as it is.

Inputs

TemplatetemplatetextRequired
The template or layout to change.
Namenametext
A new name.
Subjectsubjecttext
A new subject line (templates only).
HTML bodyhtml_bodytext
A new HTML body.
Text bodytext_bodytext
A new text body.
Aliasaliastext
A new alias.
Layoutlayouttext
Move the template to this layout.
Remove layoutremove_layouttrue/false
Stop the template using any layout.

Outputs

Activetrue/false
Aliastext
LayoutTemplatetext
Nametext
TemplateIdnumber
TemplateTypetext
Example output
{
  "Active": true,
  "Alias": "onboarding-email",
  "LayoutTemplate": null,
  "Name": "Onboarding Email",
  "TemplateId": 1234
}

On this page