Reference

bounce

Fires when an email bounces and cannot be delivered to the recipient. This includes both permanent failures (invalid addresses) and temporary issues (mailbox full).

click

Fires when a recipient clicks a link within an email message. Use this to track engagement with specific content.

inbound

Fires when an email is received at one of your inbound email addresses. Use this to process incoming messages automatically.

open

Fires when a recipient opens an email message. This provides visibility into email engagement and reader activity.

spam-complaint

Fires when a recipient marks your email as spam or junk. Monitor these to maintain your sender reputation and mailing list health.

subscription-change

Fires when a recipient's subscription status changes, such as when they opt in or opt out of mailing lists. Use this to keep your audience preferences synchronized.

delivery

Fires when an email is successfully delivered to the recipient's mail server. This confirms the message reached its destination.

smtp-api-error

Fires when there's an error processing your email through the SMTP API. This helps identify issues with your integration or email configuration.

Search bounces

Find and analyze bounced emails from your campaigns to identify delivery failures and problematic recipient addresses. Use filters like bounce type, email address, and date range to quickly diagnose why messages aren't reaching customers.

Get a single bounce

Retrieves detailed information about a specific email bounce, including the reason it failed and when it occurred, so you can understand delivery issues and manage your contact list more effectively.

Get bounce SMTP dump

Retrieve the complete SMTP server conversation for a specific bounce to understand exactly why an email failed to deliver. This raw technical data is essential for diagnosing complex delivery issues that aren't obvious from standard bounce reports.

Get delivery statistics overview

Get a quick overview of your email delivery health, including bounce rates and deactivated addresses to monitor whether your emails are reaching customers effectively.

Reactivate a bounced email address

Resume sending emails to an address that was previously bounced after confirming the recipient's mailbox issue is resolved. This helps you re-engage with contacts who had temporary delivery problems.

Get bulk email request status

Monitor the processing status and delivery progress of a bulk email campaign, including completion percentage and confirmation of all messages being processed.

Send bulk email to multiple recipients

Send the same email message to multiple recipients at once with customizable content for each person, perfect for newsletters and announcements. Track opens and clicks for each recipient individually to measure engagement.

Create a data removal request

Submit a request to permanently remove all stored data associated with a specific email address to comply with data privacy regulations like GDPR and CCPA.

Get data removal request status

Check the progress and completion status of a data removal request you've submitted. This helps you verify that customer data has been successfully deleted to maintain compliance and customer trust.

Add a sending domain

Register a new domain with your Postmark account to start sending emails from that domain. You'll need to configure DNS records afterward to authenticate the domain and ensure your emails reach inboxes reliably.

Delete a sending domain

Remove a sending domain from your Postmark account so emails from that domain will no longer be processed through Postmark's authentication system.

Get domain details

Retrieve detailed information about a sending domain including its authentication setup (DKIM, SPF, Return-Path) and verification status to ensure your emails are properly configured to reach inboxes.

List sending domains

Retrieve all sending domains configured in your account and verify their authentication status. This helps you ensure your emails are properly authenticated and have the best chance of reaching your customers' inboxes.

Rotate domain DKIM key

Generate a new DKIM authentication key pair for your email domain to replace the current one, then update your DNS records with the new key. Use this operation to maintain email security best practices and reduce the risk of key compromise.

Update domain configuration

Modify a domain's configuration, specifically the custom Return-Path domain. Use this to set up a branded bounce address (e.g., bounces.yourdomain.com) for improved deliverability and professional appearance.

Verify domain DKIM records

Verify that your DKIM records are properly set up in your DNS by triggering a lookup, which improves your email deliverability and inbox placement.

Verify domain Return-Path DNS

Verify that your Return-Path CNAME record is correctly configured in DNS to improve email deliverability and ensure bounces are properly attributed to your domain.

Verify domain SPF records (deprecated)

Checks your domain's DNS settings to confirm SPF records are correctly configured for email authentication. Note: This endpoint is deprecated; DKIM verification is now recommended for stronger security.

Send a batch of emails

Send up to 500 emails at once with different recipients, subjects, and content in a single request, making it efficient for sending notifications to multiple users simultaneously.

Send a single email

Send a transactional email to one or more recipients with support for HTML formatting, attachments, and tracking. Use this for automated messages triggered by specific user actions.

Send an email using a template

Send personalized emails using pre-built templates that automatically fill in dynamic content like customer names, order details, or custom messages. This ensures consistent, professional email designs while keeping the content relevant to each recipient.

Send batch emails using templates

Send up to 500 personalized emails at once by combining different templates and custom data for each recipient. This lets you efficiently deliver tailored messages like notifications, newsletters, or reports to large groups without making individual API calls.

Create an inbound blocking rule

Block unwanted emails from specific addresses or entire domains to keep your inbox clean and reduce spam processing. This helps you automatically filter out problematic senders without manual intervention.

Delete an inbound blocking rule

Remove an inbound blocking rule to stop filtering out messages from a specific sender or domain. Use this when you want to resume receiving emails from a previously blocked address.

List inbound rule triggers

Retrieve all inbound rule triggers that currently block incoming emails from specific senders, allowing you to review and audit your email filtering rules.

Archive a message stream

Disable a message stream from sending while keeping it available for recovery within 45 days, useful when you want to retire a communication channel without permanently deleting its history.

Create a message stream

Create a new message stream to organize and separate different types of email traffic, helping you maintain distinct sending reputations for different email categories.

Get a message stream

Retrieve detailed configuration settings for a specific message stream, including its type and subscription management rules. Use this to verify how your emails are organized and ensure unsubscribe options are properly configured.

List message streams

Retrieve all email message streams configured for your server to see how your email traffic is organized by category. Use this to understand your current setup or dynamically populate stream options in your application.

Restore an archived message stream

Restore a previously archived message stream so you can resume sending emails through it. This is useful when you archived a stream by mistake or need to reactivate it for a new campaign or customer segment.

Update a message stream

Update a message stream's name, description, or unsubscribe handling settings to reflect changes in your email program as it grows.

Search outbound messages

Find and review emails you've sent by filtering by recipient, sender, subject, date, and delivery status to verify messages were delivered and investigate any issues.

Bypass rules for a blocked inbound message

Override filtering rules to deliver a legitimate email that was incorrectly blocked by your inbound filters, ensuring important messages reach your webhook endpoint.

Get clicks for a specific message

Retrieve detailed click tracking data for all links in a sent email message, including click counts, devices, and geographic locations. Use this to understand which content resonated with your recipients and measure email engagement.

Get inbound message details

Retrieve the complete details of an inbound email including headers, body content, and attachments to inspect received messages and extract information from them.

Get opens for a specific message

Track when and how many times a specific email was opened, including details about the client and location for each open event. This helps you understand recipient engagement with individual messages.

Get outbound message details

Retrieve complete details about a sent email including its content, attachments, and full delivery history from opens to bounces. Use this to verify what was delivered and understand how recipients interacted with your message.

Get outbound message SMTP dump

Retrieve the complete raw SMTP conversation for an outbound message, including all headers and content sent to the recipient's mail server, to investigate delivery issues or email content problems.

Retry a failed inbound message

Reschedule a failed inbound message for reprocessing so you can receive and process it again at your webhook endpoint. Use this when your server was temporarily down or unable to accept the initial delivery.

Search email open events

Track and analyze which recipients have opened your emails, along with details about when, where, and what device they used to open them. This helps you understand email engagement and identify your most active audience.

Search inbound messages

Find specific incoming emails across your mailbox using filters like sender, recipient, subject, and date range to locate messages you need to review or take action on.

Search link click events

Retrieve click tracking data from your outbound emails to see which links recipients are clicking and how they're engaging with your content. Filter results by recipient, tag, client, platform, or location to understand what resonates with your audience.

Create a sender signature

Register a new email address with Postmark that you can use to send emails from your account. A verification email will be sent to confirm ownership before the address becomes active.

Delete a sender signature

Remove a sender email address from your account so you can no longer send emails from that address. Use this when you've switched email addresses or no longer need a particular sender identity.

Get sender signature details

Retrieve complete authentication details for a sender signature, including DKIM status, SPF verification, and confirmation status. Use this to verify that a sender address is fully set up and ready to send emails reliably.

List sender signatures

Retrieve all email sender addresses you've configured in your Postmark account so you can see which addresses are approved and ready to send from.

Request new DKIM for sender (deprecated)

Generates a new DKIM key for a sender signature to improve email deliverability and authentication, though this functionality has been superseded by the Domains API for more centralized management.

Resend sender confirmation email

Resend a confirmation email to verify ownership of a sender address when the original confirmation message wasn't received or has expired.

Update a sender signature

Update an existing sender signature's properties such as display name, reply-to address, and Return-Path domain without needing to create a new one. Use this to keep your email sender information current as your business evolves.

Verify sender SPF records (deprecated)

Checks whether your sender's SPF record is properly configured to authenticate emails and prevent spoofing. This endpoint is deprecated; use the Domains API for more comprehensive authentication verification instead.

Get current server configuration

Retrieve your Postmark server's complete configuration settings, including tracking options, inbound mail setup, and delivery preferences to verify your current setup or troubleshoot email delivery issues.

Update server configuration

Adjust your email server settings to control tracking features, webhook endpoints, spam filtering, and delivery behavior. Use this when you need to enable message tracking, set up event notifications, or modify how your server processes incoming emails.

Create a new server

Set up a new isolated email server with its own API credentials and configuration settings. This allows you to manage email sending and receiving separately for different projects, clients, or business needs.

Delete a server

Permanently remove a server and all its associated data from your Postmark account. This irreversible action deletes all message history, templates, and configuration for that server.

Get a server by ID

Retrieve the complete configuration details of a specific server, including all settings and metadata. This helps you audit server setups, verify configurations, or gather information about servers you manage.

List all servers in the account

Retrieve all Postmark servers set up in your account, with optional filtering by name, so you can see and manage your sending infrastructure across different projects or environments.

Update a server by ID

Update configuration settings for a specific email server in your Postmark account, such as changing bounce handling, reply-to addresses, or delivery settings without affecting other servers.

Get outbound statistics overview

Get a quick overview of your email sending performance across all key metrics like delivery rates, bounces, opens, and clicks to monitor the health of your email campaigns.

Get bounce counts by type

View your email bounce statistics broken down by type (hard bounces, soft bounces, and SMTP errors) to monitor email deliverability health and identify list quality problems.

Get clicks by browser family

Analyze which web browsers your email recipients use when clicking links, helping you understand audience behavior and optimize your landing page compatibility.

Get clicks by content location

View where recipients clicked links in your emails (HTML vs plain text content) to understand which email format drives the most engagement. This helps you optimize your email template strategy and ensure both versions have effective calls-to-action.

Get clicks by platform

View how many clicks your emails received on different device platforms like mobile and desktop. This helps you understand which devices your audience uses to engage with your content.

Get daily sent email counts

Track the number of emails sent each day over a specific time period to monitor your email marketing volume and identify sending patterns. This helps you understand campaign effectiveness and ensure steady communication with your audience.

Get email open counts

Get a breakdown of how many times your emails have been opened by recipients, including daily totals and unique opens. Use this data to measure email campaign effectiveness and understand which messages are resonating with your audience.

Get email opens by email client

View which email clients your recipients are using to open your messages, helping you understand your audience and optimize email design accordingly. This data breaks down opens by client type (Gmail, Outlook, Apple Mail, etc.) so you can see where your emails are being read.

Get email opens by platform

View how your recipients open emails across different devices like desktop, mobile, and webmail to understand which platforms your audience prefers. This helps you optimize email designs and ensure they render perfectly on the devices your readers actually use.

Get link click counts

Retrieve daily click counts for links in your emails over a specified date range to measure how much engagement your messages are generating. This helps you understand which content resonates with your audience and track the effectiveness of your campaigns.

Get spam complaint counts

Monitor how many recipients are marking your emails as spam over a specific time period to protect your sender reputation and email deliverability. Tracking complaint rates helps you identify problematic email campaigns and maintain inbox placement.

Get tracked email counts

Get daily statistics on how many of your emails have open and link tracking enabled, helping you monitor tracking coverage across your email campaigns.

Add addresses to suppression list

Prevent up to 50 email addresses from receiving future messages on a specific stream, allowing you to honor unsubscribe requests and maintain list quality without archiving contacts.

List suppressed email addresses

View all email addresses that are blocked from receiving messages in a specific message stream, with options to filter by reason, origin, or date range. This helps you understand why emails aren't being delivered and maintain a healthy sender reputation.

Remove addresses from suppression list

Remove email addresses from your suppression list to re-enable sending to contacts that were previously blocked due to bounces or manual suppression, allowing you to reconnect with customers who are now ready to receive your messages.

Create an email template

Create a reusable email template with subject line, HTML body, and plain text content that can be personalized with dynamic data for consistent branding across your email communications.

List email templates

Retrieve all your email templates with optional filtering to browse, organize, and manage your template library. This helps you audit what templates you have available and find the right one for your needs.

Delete an email template

Permanently remove an email template from your Postmark account when you no longer need it. Once deleted, the template cannot be recovered, so ensure no active campaigns or workflows are using it first.

Get a template by ID or alias

Retrieve the complete details of a specific email template, including subject line, HTML content, text version, and layout configuration. Use this to view template structure, verify content before sending campaigns, or load templates into your application for editing.

Push templates between servers

Transfer email templates from one server to another to sync changes across your development and production environments, with an optional preview mode to see what will change before making updates.

Update an email template

Update an existing email template's subject line, body content, variables, or layout to keep your email designs current and aligned with your brand. This lets you refine template content and fix issues without recreating templates from scratch.

Validate template content

Test your email template's syntax and preview how it will look with sample data before saving or deploying it. This helps catch formatting issues and errors early in your development process.

Create a webhook configuration

Set up a webhook to automatically receive real-time notifications whenever emails are delivered, bounced, opened, clicked, or marked as spam, allowing you to respond immediately to email events.

Delete a webhook configuration

Removes a webhook from your Postmark account so events stop being sent to that endpoint. Use this when you no longer need notifications at a specific URL or when replacing it with an updated webhook.

Get webhook configuration details

Retrieves the complete configuration details of a specific webhook, including its target URL, triggered events, and message stream settings. Use this to verify your webhook is set up correctly or troubleshoot why events aren't being delivered to your application.

List webhook configurations

Retrieve all configured webhooks for your email server to see which events are being sent to your endpoints and verify their setup.

Update a webhook configuration

Modify an existing webhook's configuration such as its URL, authentication headers, or which events it listens to without recreating it. Use this to adapt your webhook settings as your email infrastructure or integrations evolve.