Postmark API Explorer

Bounces API

get /deliverystats

Get delivery stats

get /bounces

Get bounces

Response Class (Status 200)

{
  "TotalCount": 0,
  "Bounces": [
    {
      "ID": "string",
      "Type": "string",
      "TypeCode": 0,
      "Name": "string",
      "Tag": "string",
      "MessageID": "string",
      "Description": "string",
      "Details": "string",
      "Email": "string",
      "BouncedAt": "2025-05-29T18:10:28.554Z",
      "DumpAvailable": true,
      "Inactive": true,
      "CanActivate": true,
      "Subject": "string",
      "Content": "string"
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Description	Data Type
X-Postmark-Server-Token	The token associated with the Server on which this request will operate.	string
count	Number of bounces to return per request. Max 500.	integer
offset	Number of bounces to skip.	integer
type	Filter by type of bounce	string
inactive	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.	boolean
emailFilter	Filter by email address	string
messageID	Filter by messageID	string
tag	Filter by tag	string
todate	Filter messages up to the date specified. e.g. `2014-02-01`	date
fromdate	Filter messages starting from the date specified. e.g. `2014-02-01`	date

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

Inbound Rules API

delete /triggers/inboundrules/{triggerid}

Delete a single trigger

get /triggers/inboundrules

List inbound rule triggers

post /triggers/inboundrules

Create an inbound rule trigger

Messages API

get /messages/outbound

Outbound message search

Response Class (Status 200)

{
  "TotalCount": 0,
  "Messages": [
    {
      "Tag": "string",
      "MessageID": "string",
      "To": [
        {
          "Name": "string",
          "Email": "string"
        }
      ],
      "Cc": [
        {
          "Name": "string",
          "Email": "string"
        }
      ],
      "Bcc": [
        {
          "Name": "string",
          "Email": "string"
        }
      ],
      "Recipients": [
        "string"
      ],
      "ReceivedAt": "2025-05-29T18:10:28.580Z",
      "From": "string",
      "Subject": "string",
      "Attachments": [
        {
          "Name": "string",
          "Content": "string",
          "ContentType": "string",
          "ContentID": "string"
        }
      ],
      "Status": "string",
      "TrackOpens": true,
      "TrackLinks": "None"
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Description	Data Type
X-Postmark-Server-Token	The token associated with the Server on which this request will operate.	string
count	Number of messages to return per request. Max 500.	integer
offset	Number of messages to skip	integer
recipient	Filter by the user who was receiving the email	string
fromemail	Filter by the sender email address	string
tag	Filter by tag	string
status	Filter by status (`queued` or `sent`)	string
todate	Filter messages up to the date specified. e.g. `2014-02-01`	date
fromdate	Filter messages starting from the date specified. e.g. `2014-02-01`	date

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

get /messages/outbound/{messageid}/details

Outbound message details

Response Class (Status 200)

{
  "TextBody": "string",
  "HtmlBody": "string",
  "Body": "string",
  "Tag": "string",
  "MessageID": "string",
  "To": [
    {
      "Name": "string",
      "Email": "string"
    }
  ],
  "Cc": [
    {
      "Name": "string",
      "Email": "string"
    }
  ],
  "Bcc": [
    {
      "Name": "string",
      "Email": "string"
    }
  ],
  "Recipients": [
    "string"
  ],
  "ReceivedAt": "2025-05-29T18:10:28.586Z",
  "From": "string",
  "Subject": "string",
  "Attachments": [
    {
      "Name": "string",
      "Content": "string",
      "ContentType": "string",
      "ContentID": "string"
    }
  ],
  "Status": "string",
  "TrackOpens": true,
  "TrackLinks": "None",
  "MessageEvents": [
    {
      "Recipient": "string",
      "Type": "string",
      "ReceivedAt": "2025-05-29T18:10:28.586Z",
      "Details": {
        "Summary": "string",
        "BounceID": "string",
        "DeliveryMessage": "string",
        "DestinationServer": "string",
        "DestinationIP": "string"
      }
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Value	Description	Data Type
X-Postmark-Server-Token		The token associated with the Server on which this request will operate.	string
messageid		The ID of the message for which to retrieve details.	string

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

get /messages/outbound/{messageid}/dump

Outbound message dump

get /messages/inbound

Inbound message search

Response Class (Status 200)

{
  "TotalCount": 0,
  "InboundMessages": [
    {
      "From": "string",
      "FromName": "string",
      "FromFull": {
        "Email": "string",
        "Name": "string"
      },
      "To": "string",
      "ToFull": [
        {
          "Name": "string",
          "Email": "string"
        }
      ],
      "Cc": "string",
      "CcFull": [
        {
          "Name": "string",
          "Email": "string"
        }
      ],
      "ReplyTo": "string",
      "OriginalRecipient": "string",
      "Subject": "string",
      "Date": "string",
      "MailboxHash": "string",
      "Tag": "string",
      "Attachments": [
        {
          "Name": "string",
          "Content": "string",
          "ContentType": "string",
          "ContentID": "string"
        }
      ],
      "MessageID": "string",
      "Status": "string"
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Description	Data Type
X-Postmark-Server-Token	The token associated with the Server on which this request will operate.	string
count	Number of messages to return per request. Max 500.	integer
offset	Number of messages to skip	integer
recipient	Filter by the user who was receiving the email	string
fromemail	Filter by the sender email address	string
subject	Filter by email subject	string
mailboxhash	Filter by mailboxhash	string
tag	Filter by tag	string
status	Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`)	string
todate	Filter messages up to the date specified. e.g. `2014-02-01`	date
fromdate	Filter messages starting from the date specified. e.g. `2014-02-01`	date

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

get /messages/inbound/{messageid}/details

Inbound message details

get /messages/outbound/opens

Opens for all messages

Response Class (Status 200)

{
  "TotalCount": 0,
  "Opens": [
    {
      "FirstOpen": true,
      "Client": {
        "Name": "string",
        "Company": "string",
        "Family": "string"
      },
      "OS": {
        "Name": "string",
        "Company": "string",
        "Family": "string"
      },
      "Platform": "string",
      "UserAgent": "string",
      "Geo": {
        "CountryISOCode": "string",
        "Country": "string",
        "RegionISOCode": "string",
        "Region": "string",
        "City": "string",
        "Zip": "string",
        "Coords": "string",
        "IP": "string"
      },
      "MessageID": "string",
      "ReceivedAt": "2025-05-29T18:10:28.601Z",
      "Tag": "string",
      "Recipient": "string"
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Description	Data Type
X-Postmark-Server-Token	The token associated with the Server on which this request will operate.	string
count	Number of message opens to return per request. Max 500.	integer
offset	Number of messages to skip	integer
recipient	Filter by To, Cc, Bcc	string
tag	Filter by tag	string
client_name	Filter by client name, i.e. Outlook, Gmail	string
client_company	Filter by company, i.e. Microsoft, Apple, Google	string
client_family	Filter by client family, i.e. OS X, Chrome	string
os_name	Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7	string
os_family	Filter by kind of OS used without specific version, i.e. OS X, Windows	string
os_company	Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation	string
platform	Filter by platform, i.e. webmail, desktop, mobile	string
country	Filter by country messages were opened in, i.e. Denmark, Russia	string
region	Filter by full name of region messages were opened in, i.e. Moscow, New York	string
city	Filter by full name of region messages were opened in, i.e. Moscow, New York	string

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

get /messages/outbound/opens/{messageid}

Retrieve Message Opens

get /messages/outbound/clicks

Clicks for a all messages

Response Class (Status 200)

{
  "TotalCount": 0,
  "Clicks": [
    {
      "ClickLocation": "string",
      "Client": {
        "Name": "string",
        "Company": "string",
        "Family": "string"
      },
      "OS": {
        "Name": "string",
        "Company": "string",
        "Family": "string"
      },
      "Platform": "string",
      "UserAgent": "string",
      "OriginalLink": "string",
      "Geo": {
        "CountryISOCode": "string",
        "Country": "string",
        "RegionISOCode": "string",
        "Region": "string",
        "City": "string",
        "Zip": "string",
        "Coords": "string",
        "IP": "string"
      },
      "MessageID": "string",
      "ReceivedAt": "2025-05-29T18:10:28.612Z",
      "Tag": "string",
      "Recipient": "string"
    }
  ]
}

Authentication

X-Postmark-Server-Token:

Parameters

Parameter	Description	Data Type
X-Postmark-Server-Token	The token associated with the Server on which this request will operate.	string
count	Number of message clicks to return per request. Max 500.	integer
offset	Number of messages to skip	integer
recipient	Filter by To, Cc, Bcc	string
tag	Filter by tag	string
client_name	Filter by client name, i.e. Outlook, Gmail	string
client_company	Filter by company, i.e. Microsoft, Apple, Google	string
client_family	Filter by client family, i.e. OS X, Chrome	string
os_name	Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7	string
os_family	Filter by kind of OS used without specific version, i.e. OS X, Windows	string
os_company	Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation	string
platform	Filter by platform, i.e. webmail, desktop, mobile	string
country	Filter by country messages were opened in, i.e. Denmark, Russia	string
region	Filter by full name of region messages were opened in, i.e. Moscow, New York	string
city	Filter by full name of region messages were opened in, i.e. Moscow, New York	string

HTTP Response Codes

Check out our API Documentation for a complete list of our HTTP response codes.

get /messages/outbound/clicks/{messageid}

Retrieve Message Clicks

put /messages/inbound/{messageid}/bypass

Bypass rules for a blocked inbound message

put /messages/inbound/{messageid}/retry

Retry a failed inbound message for processing

Sending API

post /email

Send a single email

post /email/batch

Send a batch of emails

post /email/withTemplate

Send an email using a Template

post /email/batchWithTemplates

Send a batch of email using templates.

Server Configuration API

get /server

Get Server Configuration

put /server

Edit Server Configuration

Stats API

get /stats/outbound

Get outbound overview

get /stats/outbound/sends

Get sent counts

get /stats/outbound/bounces

Get bounce counts

get /stats/outbound/spam

Get spam complaints

get /stats/outbound/tracked

Get tracked email counts

get /stats/outbound/opens

Get email open counts

get /stats/outbound/opens/platforms

Get email platform usage

get /stats/outbound/opens/emailclients

Get email client usage

get /stats/outbound/clicks

Get click counts

get /stats/outbound/clicks/browserfamilies

Get browser usage by family

get /stats/outbound/clicks/platforms

Get browser plaform usage

get /stats/outbound/clicks/location

Get clicks by body location

Templates API

delete /templates/{templateIdOrAlias}

Delete a Template

get /templates

Get the Templates associated with this Server

get /templates/{templateIdOrAlias}

Get a Template

post /email/withTemplate

Send an email using a Template

post /email/batchWithTemplates

Send a batch of email using templates.

post /templates

Create a Template

post /templates/validate

Test Template Content

put /templates/{templateIdOrAlias}

Update a Template

Domains API

delete /domains/{domainid}

Delete a Domain

get /domains

List Domains

get /domains/{domainid}

Get a Domain

post /domains

Create a Domain

post /domains/{domainid}/verifyspf

Request DNS Verification for SPF

post /domains/{domainid}/rotatedkim

Rotate DKIM Key

put /domains/{domainid}

Update a Domain

put /domains/{domainid}/verifydkim

Request DNS Verification for DKIM

put /domains/{domainid}/verifyreturnpath

Request DNS Verification for Return-Path

Sender Signatures API

delete /senders/{signatureid}

Delete a Sender Signature

get /senders

List Sender Signatures

get /senders/{signatureid}

Get a Sender Signature

post /senders

Create a Sender Signature

post /senders/{signatureid}/resend

Resend Signature Confirmation Email

post /senders/{signatureid}/verifyspf

Request DNS Verification for SPF

post /senders/{signatureid}/requestnewdkim

Request a new DKIM Key

put /senders/{signatureid}

Update a Sender Signature

Server Management API

delete /servers/{serverid}

Delete a Server

get /servers/{serverid}

Get a Server

get /servers

List servers

post /servers

Create a Server

put /servers/{serverid}

Edit a Server

Templates API

put /templates/push

Push templates from one server to another

Parameter	Value	Description	Data Type
X-Postmark-Account-Token		The token associated with the Account on which this request will operate.	string
domainid		The ID for the Domain that should be deleted by the request.	integer

Before you get started

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code

Response Headers

Response Class (Status 200)

Authentication

Parameters

HTTP Response Codes

Curl

Request URL

Request Headers

Response Body

Response Code