Postmarkapp

Postmark API

Postmark makes sending and receiving email incredibly easy.

Communication#openapi#email

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Postmark makes sending and receiving email
incredibly easy.

Endpoints 43

Bounces API

  • GETGet bounces/bounces?count=0&offset=0&type=HardBounce&inactive=true&emailFilter=user@example.com&messageID=string&tag=string&todate=2024-01-01&fromdate=2024-01-01
  • GETGet a single bounce/bounces/:bounceid
  • PUTActivate a bounce/bounces/:bounceid/activate
  • GETGet bounce dump/bounces/:bounceid/dump
  • GETGet delivery stats/deliverystats

Sending API

  • POSTSend a single email/email
  • POSTSend a batch of emails/email/batch
  • POSTSend a batch of email using templates./email/batchWithTemplates
  • POSTSend an email using a Template/email/withTemplate

Messages API

  • GETInbound message search/messages/inbound?count=0&offset=0&recipient=user@example.com&fromemail=user@example.com&subject=string&mailboxhash=string&tag=string&status=blocked&todate=2024-01-01&fromdate=2024-01-01
  • PUTBypass rules for a blocked inbound message/messages/inbound/:messageid/bypass
  • GETInbound message details/messages/inbound/:messageid/details
  • PUTRetry a failed inbound message for processing/messages/inbound/:messageid/retry
  • GETOutbound message search/messages/outbound?count=0&offset=0&recipient=user@example.com&fromemail=user@example.com&tag=string&status=queued&todate=2024-01-01&fromdate=2024-01-01
  • GETClicks for a all messages/messages/outbound/clicks?count=0&offset=0&recipient=string&tag=string&client_name=string&client_company=string&client_family=string&os_name=string&os_family=string&os_company=string&platform=string&country=string&region=string&city=string
  • GETRetrieve Message Clicks/messages/outbound/clicks/:messageid?count=1&offset=0
  • GETOpens for all messages/messages/outbound/opens?count=0&offset=0&recipient=string&tag=string&client_name=string&client_company=string&client_family=string&os_name=string&os_family=string&os_company=string&platform=string&country=string&region=string&city=string
  • GETRetrieve Message Opens/messages/outbound/opens/:messageid?count=1&offset=0
  • GETOutbound message details/messages/outbound/:messageid/details
  • GETOutbound message dump/messages/outbound/:messageid/dump

Server Configuration API

  • GETGet Server Configuration/server
  • PUTEdit Server Configuration/server

Stats API

  • GETGet outbound overview/stats/outbound?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet bounce counts/stats/outbound/bounces?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet click counts/stats/outbound/clicks?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet browser usage by family/stats/outbound/clicks/browserfamilies?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet clicks by body location/stats/outbound/clicks/location?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet browser plaform usage/stats/outbound/clicks/platforms?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet email open counts/stats/outbound/opens?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet email client usage/stats/outbound/opens/emailclients?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet email platform usage/stats/outbound/opens/platforms?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet sent counts/stats/outbound/sends?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet spam complaints/stats/outbound/spam?tag=string&fromdate=2024-01-01&todate=2024-01-01
  • GETGet tracked email counts/stats/outbound/tracked?tag=string&fromdate=2024-01-01&todate=2024-01-01

Templates API

  • GETGet the Templates associated with this Server/templates?Count=0.0&Offset=0.0
  • POSTCreate a Template/templates
  • POSTTest Template Content/templates/validate
  • GETGet a Template/templates/:templateIdOrAlias
  • PUTUpdate a Template/templates/:templateIdOrAlias
  • DELETEDelete a Template/templates/:templateIdOrAlias

Inbound Rules API

  • GETList inbound rule triggers/triggers/inboundrules?count=0&offset=0
  • POSTCreate an inbound rule trigger/triggers/inboundrules
  • DELETEDelete a single trigger/triggers/inboundrules/:triggerid

API details

Base URL
https://api.postmarkapp.com
Authentication
None declared in the description
Operations
43 operations on 38 pathsGET 29POST 7PUT 5DELETE 2
Main resources
Stats API 12Messages API 11Templates API 8Bounces API 5Sending API 4Inbound Rules API 3Server Configuration API 2
Response formats
application/json
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Postmark API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Postmark API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get bounces” (GET /bounces?count=0&offset=0&type=HardBounce&inactive=true&emailFilter=user@example.com&messageID=string&tag=string&todate=2024-01-01&fromdate=2024-01-01), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Postmark API?

Postmark makes sending and receiving email incredibly easy. It is listed under Communication and has 43 endpoints.

Who publishes the Postmark API?

It is listed from Postmarkapp's public API description (an OpenAPI document), not published by Postmarkapp on Swastik Codes. Anyone who controls postmarkapp.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Postmark API?

Requests go to https://api.postmarkapp.com. Endpoint paths are added to this base URL.

How do I authenticate with the Postmark API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Postmark API have?

43 operations on 38 paths (29 GET, 7 POST, 5 PUT, 2 DELETE). The largest groups are Stats API, Messages API, Templates API, Bounces API.

Is forking the Postmark API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.