Postmark

Overview

Postmark is a transactional email delivery service focused on high deliverability and detailed tracking. Unlike generic marketing email solutions, Postmark is optimized for application emails — account confirmations, password resets, notifications, and similar use cases. With the Postmark integration in SquadOS, your agents can send emails, create and manage templates, monitor bounces, manage suppression lists, and analyze comprehensive open, click, and deliverability statistics.

• Official website: https://postmarkapp.com/
• Composio documentation: docs.composio.dev/toolkits/postmark

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	Postmark Server Token, used in the X-Postmark-Server-Token header to authenticate all API requests.

How to get credentials

1. Go to account.postmarkapp.com/login and log in to your Postmark account.
2. On the main servers screen, click the server you want to connect (or create a new one by clicking Create Server).
3. Inside the server, click the API Tokens tab.
4. Copy the Server Token value shown — this is the value to use in the api_key field when connecting in SquadOS.

Tip

Each Postmark server has its own token. Use separate tokens per environment (production, development) to isolate data and allow revocation without impacting other servers. For testing, the special token POSTMARK_API_TEST sends emails without actual delivery.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Postmark.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the Server Token obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Archive Message Stream

POSTMARK_ARCHIVE_MESSAGE_STREAM

Tool to archive a message stream (soft delete). Use when you need to remove a message stream that will be permanently deleted after 45 days.

Input parameters

Name	Type	Required	Description
stream_id	string	Yes	The ID of the message stream to archive

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Check Spam Score

POSTMARK_CHECK_SPAM_SCORE

Tool to assess the spam score of a raw email via the SpamCheck API. Use when you have full email source and need spam scoring before sending. Returns spam score and detailed report.

Input parameters

Name	Type	Required	Description
email	string	Yes	Full raw email source to analyze for spam scoring
options	string	No	Detail level of the report: short, long, or summary. Defaults to short.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Inbound Rule

POSTMARK_CREATE_INBOUND_RULE

Tool to create a new inbound rule trigger to block email from a specific sender or domain. Use when you need to prevent emails from specific addresses or domains from being processed.

Input parameters

Name	Type	Required	Description
Rule	string	Yes	Email address or domain to block from inbound messages (e.g., spam@example.com or baddomain.com)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Message Stream

POSTMARK_CREATE_MESSAGE_STREAM

Tool to create a new message stream. Use when you need to set up separate streams for transactional or broadcast emails.

Input parameters

Name	Type	Required	Description
ID	string	Yes	The stream identifier (e.g., transactional-dev). Must be unique within the server.
Name	string	Yes	The name of the message stream
Description	string	No	A description of the message stream
MessageStreamType	string	Yes	The type of stream: Transactional for transactional emails or Broadcasts for marketing emails

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Suppressions

POSTMARK_CREATE_SUPPRESSIONS

Tool to add email addresses to the suppression list for a message stream. Use when you need to prevent emails from being sent to specific addresses.

Input parameters

Name	Type	Required	Description
stream_id	string	Yes	The message stream ID (e.g., outbound, broadcast)
Suppressions	array	Yes	Array of email addresses to suppress (max 50 per request)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Template

POSTMARK_CREATE_TEMPLATE

Tool to create a new email template. Use when you need reusable templates before sending emails.

Input parameters

Name	Type	Required	Description
Name	string	Yes	Template name (max 255 characters)
Alias	string	No	Unique template alias (max 100 characters)
Subject	string	Yes	Template subject line, can include variables, e.g., {{name}}
HtmlBody	string	Yes	HTML content of the template
TextBody	string	Yes	Plain text content of the template
TemplateType	string	Yes	Type of the template: Standard or Layout
LayoutTemplate	string	No	Alias or ID of a layout template (required for Standard templates using a layout)
AssociatedServerId	integer	No	Server ID to associate this template with

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Create Webhook

POSTMARK_CREATE_WEBHOOK

Tool to create a new webhook configuration for Postmark. Use when you need to set up a webhook to receive event notifications for email tracking (opens, clicks, bounces, deliveries, etc.).

Input parameters

Name	Type	Required	Description
Url	string	Yes	The webhook URL endpoint where events will be sent.
HttpAuth	object	No	HTTP authentication credentials for the webhook endpoint.
Triggers	object	No	Defines which events trigger this webhook.
HttpHeaders	array	No	Optional array of custom headers to include in webhook requests.
MessageStream	string	No	The message stream for this webhook (e.g., outbound, inbound). Defaults to outbound if not specified.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Inbound Rule

POSTMARK_DELETE_INBOUND_RULE

Tool to delete a specific inbound rule trigger. Use when you need to remove an inbound rule by its ID after confirming it’s no longer needed.

Input parameters

Name	Type	Required	Description
triggerid	integer	Yes	The ID of the Inbound Rule that should be deleted.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Suppressions

POSTMARK_DELETE_SUPPRESSIONS

Tool to remove email addresses from the suppression list for a message stream. Use when you need to reactivate previously suppressed email addresses. Note that only HardBounce and ManualSuppression types can be deleted; SpamComplaint suppressions cannot be removed.

Input parameters

Name	Type	Required	Description
stream_id	string	Yes	The unique identifier for the Message Stream (e.g., outbound, inbound)
Suppressions	array	Yes	Array of email addresses to remove from suppression list (maximum 50 per request). Note: SpamComplaint suppressions cannot be deleted, only HardBounce and ManualSuppression types can be removed.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Template

POSTMARK_DELETE_TEMPLATE

Tool to delete a template by its ID or alias. Use when you need to permanently remove a template after confirming it’s no longer needed.

Input parameters

Name	Type	Required	Description
templateIdOrAlias	string	Yes	The TemplateID (numeric) or Alias (string) value for the template you wish to delete

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Delete Webhook

POSTMARK_DELETE_WEBHOOK

Tool to delete a specific webhook. Use when you need to remove a webhook by its ID after confirming it’s no longer needed.

Input parameters

Name	Type	Required	Description
webhookID	integer	Yes	ID of the webhook to delete

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Edit Server

POSTMARK_EDIT_SERVER

Tool to update settings for the current Postmark server. Use when you need to modify server configuration.

Input parameters

Name	Type	Required	Description
Name	string	Yes	Name of the server.
Color	string	No	Hex color code for the server, e.g., #FF0000.
OpenHookUrl	string	No	URL to POST open webhook events.
BounceHookUrl	string	No	URL to POST bounce webhook events.
InboundDomain	string	No	Domain to handle inbound emails.
InboundHookUrl	string	No	URL to POST inbound email webhook events.
DeliveryHookUrl	string	No	URL to POST delivery webhook events.
RawEmailEnabled	boolean	No	Enable or disable raw email support.
SmtpApiActivated	boolean	No	Enable or disable SMTP API for the server.
PostFirstOpenOnly	boolean	No	Send open webhook only on the first open event.
InboundSpamThreshold	integer	No	Spam score threshold for inbound email, must be non-negative.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Edit Template

POSTMARK_EDIT_TEMPLATE

Tool to update an existing Postmark template by its ID. Use when you need to modify a template’s name, subject, HTML or text body, alias, type, layout, or active status.

Input parameters

Name	Type	Required	Description
Name	string	No	New name for the template
Alias	string	No	Alias for easier lookup of the template
Active	boolean	No	Whether the template should be active (true) or inactive (false)
Subject	string	No	Subject line for the template
HtmlBody	string	No	HTML body content of the template
TextBody	string	No	Plain-text body content of the template
templateID	integer	Yes	The unique ID of the template to update
TemplateType	string	No	Type of template: Standard or Layout
LayoutTemplate	string	No	Alias of a layout template to wrap this template with (for Standard templates)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Edit Webhook

POSTMARK_EDIT_WEBHOOK

Tool to update an existing webhook’s URL or triggers. Use when you need to modify webhook settings after confirming the webhookID.

Input parameters

Name	Type	Required	Description
Url	string	Yes	The URL to receive webhook POSTs
Triggers	object	Yes	Event triggers for the webhook; keys are event names, values indicate if enabled
AuthToken	string	No	Optional secret token for authenticating webhook calls
webhookID	integer	Yes	ID of the webhook to update

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Bounce Counts

POSTMARK_GET_BOUNCE_COUNTS

Tool to get total counts of emails that have been returned as bounced. Use when you need aggregate bounce statistics and per-day breakdown by bounce type (hard bounce, soft bounce, transient, SMTP API errors).

Input parameters

Name	Type	Required	Description
tag	string	No	Filter bounce statistics by a specific tag.
todate	string	No	Filter stats up to this date (YYYY-MM-DD format).
fromdate	string	No	Filter stats starting from this date (YYYY-MM-DD format).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Bounces

POSTMARK_GET_BOUNCES

Tool to retrieve a list of bounces for a server with optional filters. Use when you need to page through bounce data after applying filters.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter bounces sent with this tag.
type	string	No	Filter by bounce type. Exact match, e.g., HardBounce, Transient, SoftBounce, SpamComplaint.
count	integer	No	Number of bounces to return per page (1-500).
offset	integer	No	Number of bounces to skip for pagination.
todate	string	No	Only include bounces before this ISO-8601 datetime.
fromdate	string	No	Only include bounces after this ISO-8601 datetime.
inactive	boolean	No	If true, return only inactive bounces.
messageID	string	No	Return bounces for this specific message ID.
emailFilter	string	No	Return bounces for this specific email address.
mailboxHash	string	No	Filter by mailbox hash (the part after + in the email).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Browser Platform Usage

POSTMARK_GET_BROWSER_PLATFORM_USAGE

Tool to retrieve browser platform usage statistics for clicked links. Use after sending outbound emails with tracked links to analyze engagement by browser.

Input parameters

Name	Type	Required	Description
tag	string	No	Optional filter by tag to narrow down statistics to specific emails
todate	string	No	Filter end date (inclusive) in YYYY-MM-DD format, e.g., 2024-02-01
fromdate	string	No	Filter starting date (inclusive) in YYYY-MM-DD format, e.g., 2024-01-01
messagestream	string	No	Optional filter by message stream; includes all streams if omitted

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Browser Usage

POSTMARK_GET_BROWSER_USAGE

Tool to retrieve browser usage statistics for clicked links. Use after sending tracked outbound emails to analyze which browsers and platforms were used to click links.

Input parameters

Name	Type	Required	Description
ToDate	string	Yes	End date for stats range in YYYY-MM-DD format.
FromDate	string	Yes	Start date for stats range in YYYY-MM-DD format.
ServerID	integer	No	Filter stats by server id (optional)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Click Counts

POSTMARK_GET_CLICK_COUNTS

Tool to retrieve total click counts across all links in emails. Use when you need aggregated click metrics for a given date range.

Input parameters

Name	Type	Required	Description
os	string	No	Filter by operating system.
tag	string	No	Filter by specific tag.
todate	string	Yes	End date for stats range in YYYY-MM-DD format.
country	string	No	Filter by country code.
fromdate	string	Yes	Start date for stats range in YYYY-MM-DD format.
platform	string	No	Filter by client platform.
client_name	string	No	Filter by client name.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Clicks By Browser Family

POSTMARK_GET_CLICKS_BY_BROWSER_FAMILY

Tool to retrieve click statistics grouped by browser family. Use after sending outbound emails with tracked links to analyze which browser families recipients used to click links. Requires link tracking to be enabled for emails.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by specific tag to narrow down statistics to emails with this tag
todate	string	No	Filter end date (inclusive) in YYYY-MM-DD format
fromdate	string	No	Filter starting date (inclusive) in YYYY-MM-DD format

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Clicks by Location

POSTMARK_GET_CLICKS_BY_LOCATION

Tool to get an overview of which part of the email links were clicked from (HTML or Text). Use when you need to analyze click patterns by content type.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag.
todate	string	No	Filter stats up to the date specified in YYYY-MM-DD format.
fromdate	string	No	Filter stats starting from the date specified in YYYY-MM-DD format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Delivery Stats

POSTMARK_GET_DELIVERY_STATS

Tool to retrieve delivery statistics. Use after sending emails to get aggregated counts of deliveries, bounces, and spam complaints.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Email Client Usage

POSTMARK_GET_EMAIL_CLIENT_USAGE

Tool to retrieve statistics on email clients used to open emails. Use when you need to analyze which clients recipients open your outbound emails.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag name (if emails were sent with a tag)
todate	string	No	End date for the statistics (inclusive, format: YYYY-MM-DD)
fromdate	string	No	Start date for the statistics (inclusive, format: YYYY-MM-DD)
messagestream	string	No	Filter by message stream ID. If omitted, returns stats for all server streams.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Email Open Counts

POSTMARK_GET_EMAIL_OPEN_COUNTS

Tool to retrieve counts of opened emails. Use when you need per-day and total open stats for a specified period.

Input parameters

Name	Type	Required	Description
ToDate	string	No	Include activity before this ISO8601 date/time.
FromDate	string	No	Include activity from this ISO8601 date/time.
MessageStream	string	No	Filter stats by a specific message stream.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Message Stream

POSTMARK_GET_MESSAGE_STREAM

Tool to retrieve details of a specific message stream by its ID. Use when you need to inspect stream configuration such as type, description, or subscription settings.

Input parameters

Name	Type	Required	Description
streamID	string	Yes	The ID of the message stream to retrieve (e.g., outbound, inbound, or custom stream ID)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Opens by Platform

POSTMARK_GET_OPENS_BY_PLATFORM

Tool to retrieve email open statistics by platform type. Use when you need to understand which platforms recipients use to open emails.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag to narrow down statistics to specific emails
todate	string	No	Filter end date (inclusive) in YYYY-MM-DD format, e.g., 2014-02-01
fromdate	string	No	Filter starting date (inclusive) in YYYY-MM-DD format, e.g., 2014-01-01

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Outbound Overview

POSTMARK_GET_OUTBOUND_OVERVIEW

Tool to retrieve outbound email statistics overview. Use when you need aggregated outbound metrics after sending emails.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Sent Counts

POSTMARK_GET_SENT_COUNTS

Tool to retrieve total count of emails sent out. Use when you need per-day and total sent statistics for a specified period.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by specific tag to get sent counts for emails with that tag.
todate	string	No	End date for stats range in YYYY-MM-DD format. If not provided, defaults to today.
fromdate	string	No	Start date for stats range in YYYY-MM-DD format. If not provided, defaults to 30 days ago.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Server

POSTMARK_GET_SERVER

Tool to retrieve details of the current Postmark server. Use when you need to inspect server configuration (webhooks, tracking, tokens, etc.) before other operations.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Spam Complaints

POSTMARK_GET_SPAM_COMPLAINTS

Tool to retrieve counts of spam complaints. Use when analyzing spam feedback trends after sending campaigns.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag associated with emails
to_date	string	No	Filter stats up to and including this date (YYYY-MM-DD format)
from_date	string	No	Filter stats starting from this date (YYYY-MM-DD format)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Template

POSTMARK_GET_TEMPLATE

Tool to retrieve details of a specific template by its ID. Use after obtaining a template ID to inspect its configuration.

Input parameters

Name	Type	Required	Description
templateID	integer	Yes	The unique numeric ID of the template to retrieve

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Tracked Email Counts

POSTMARK_GET_TRACKED_EMAIL_COUNTS

Tool to retrieve counts of emails with tracking enabled. Use after specifying a date range to analyze open and click metrics.

Input parameters

Name	Type	Required	Description
todate	string	Yes	End date of the tracking period in YYYY-MM-DD format
fromdate	string	Yes	Start date of the tracking period in YYYY-MM-DD format

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Get Webhook

POSTMARK_GET_WEBHOOK

Tool to retrieve details of a specific webhook by its ID. Use when you need to inspect webhook configuration including URL, triggers, and message stream settings.

Input parameters

Name	Type	Required	Description
webhook_id	integer	Yes	The unique identifier of the webhook to retrieve

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Inbound Rules

POSTMARK_LIST_INBOUND_RULES

Tool to list all inbound rules (triggers) configured for blocking senders. Use when you need to retrieve configured inbound rules with pagination support.

Input parameters

Name	Type	Required	Description
count	integer	No	Number of inbound rules to return per page. Required by the API.
offset	integer	No	Number of inbound rules to skip for pagination. Required by the API.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Message Streams

POSTMARK_LIST_MESSAGE_STREAMS

Tool to list all message streams for a Postmark server with optional type and archive filtering. Use when you need to retrieve available message streams. A server may have up to 10 streams including defaults.

Input parameters

Name	Type	Required	Description
MessageStreamType	string	No	Message stream type options for filtering: Transactional, Broadcasts, Inbound, or all.
IncludeArchivedStreams	boolean	No	Include archived streams in the response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Outbound Message Clicks

POSTMARK_LIST_OUTBOUND_MESSAGE_CLICKS

Tool to list clicks for outbound messages with filtering options. Use when you need to retrieve click events with pagination and optional filters like recipient, tag, client, OS, platform, or geographic location.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag associated with the message.
city	string	No	Filter by full name of city messages were clicked in, e.g. Moscow, New York.
count	integer	Yes	Number of message clicks to return per request. Max 500.
offset	integer	Yes	Number of messages to skip for pagination.
region	string	No	Filter by full name of region messages were clicked in, e.g. Moscow, New York.
country	string	No	Filter by country messages were clicked in, e.g. Denmark, Russia.
os_name	string	No	Filter by full OS name and specific version, e.g. OS X 10.9 Mavericks, Windows 7.
platform	string	No	Filter by platform, e.g. webmail, desktop, mobile.
os_family	string	No	Filter by kind of OS used without specific version, e.g. OS X, Windows.
recipient	string	No	Filter by To, Cc, or Bcc recipient email address.
os_company	string	No	Filter by company which produced the OS, e.g. Apple Computer, Inc., Microsoft Corporation.
client_name	string	No	Filter by client name, e.g. Outlook, Gmail.
client_family	string	No	Filter by client family, e.g. OS X, Chrome.
client_company	string	No	Filter by company that makes the client, e.g. Microsoft, Apple, Google.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Outbound Message Opens

POSTMARK_LIST_OUTBOUND_MESSAGE_OPENS

Tool to retrieve opens for outbound messages with filtering options. Use when you need to analyze email open events with detailed client, OS, and geographic data.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by message tag.
city	string	No	Filter by city where messages were opened, e.g., Moscow, New York, San Francisco.
count	integer	No	Number of message opens to return per request. Max 500.
offset	integer	No	Number of messages to skip for pagination.
region	string	No	Filter by full name of region where messages were opened, e.g., Moscow, New York, California.
country	string	No	Filter by country where messages were opened, e.g., Denmark, Russia, United States.
os_name	string	No	Filter by full OS name and specific version, e.g., OS X 10.9 Mavericks, Windows 7.
platform	string	No	Filter by platform type, e.g., webmail, desktop, mobile.
os_family	string	No	Filter by kind of OS used without specific version, e.g., OS X, Windows, Linux.
recipient	string	No	Filter by To, Cc, or Bcc recipient email address.
os_company	string	No	Filter by company which produced the OS, e.g., Apple Computer, Inc., Microsoft Corporation.
client_name	string	No	Filter by client name, e.g., Outlook, Gmail, Chrome.
client_family	string	No	Filter by client family, e.g., OS X, Chrome, Firefox.
client_company	string	No	Filter by client company, e.g., Microsoft, Apple, Google.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Suppressions

POSTMARK_LIST_SUPPRESSIONS

Tool to retrieve the suppression list for a message stream with optional filtering. Use when you need to view all suppressed email addresses for a stream.

Input parameters

Name	Type	Required	Description
Origin	string	No	Source of the suppression entry: Recipient, Customer, or Admin.
todate	string	No	Include suppressions up to this date (format: YYYY-MM-DD, e.g., 2020-02-01)
fromdate	string	No	Include suppressions from this date onwards (format: YYYY-MM-DD, e.g., 2020-02-01)
stream_id	string	Yes	The message stream ID to retrieve suppressions from (e.g., outbound, broadcast)
EmailAddress	string	No	Filter results by specific email address
SuppressionReason	string	No	Reason for email suppression: HardBounce, SpamComplaint, or ManualSuppression.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Templates

POSTMARK_LIST_TEMPLATES

Tool to list all templates for a Postmark server. Use when you need to retrieve available templates with optional pagination and filters.

Input parameters

Name	Type	Required	Description
count	integer	No	Number of templates to return per page (1-500). Required by the API.
offset	integer	No	Number of templates to skip for pagination. Required by the API.
templateType	string	No	Filter templates by type: Layout or Standard.
templateActive	string	No	Filter templates by statuses: true, false, or true,false.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

List Webhooks

POSTMARK_LIST_WEBHOOKS

Tool to list all webhooks configured for your Postmark account. Use after authenticating your server token to retrieve current webhook configurations.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Search Inbound Messages

POSTMARK_SEARCH_INBOUND_MESSAGES

Tool to search inbound messages received with optional filtering. Use when you need to retrieve inbound emails with pagination and various filters.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag.
count	integer	No	Number of messages to return per request. Max 500.
offset	integer	No	Number of messages to skip for pagination.
status	string	No	Status values for inbound messages: blocked, processed, queued, failed, or scheduled.
todate	string	No	Filter messages up to the date specified. e.g. 2014-02-01
subject	string	No	Filter by email subject.
fromdate	string	No	Filter messages starting from the date specified. e.g. 2014-02-01
fromemail	string	No	Filter by the sender email address.
recipient	string	No	Filter by the user who was receiving the email.
mailboxhash	string	No	Filter by mailbox hash.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Search Outbound Messages

POSTMARK_SEARCH_OUTBOUND_MESSAGES

Tool to search outbound messages with filtering by recipient, tag, status, and date range. Use when you need to query sent messages with specific filters or pagination.

Input parameters

Name	Type	Required	Description
tag	string	No	Filter by tag.
count	integer	No	Number of messages to return per request. Max 500. Required by the API.
offset	integer	No	Number of messages to skip for pagination. Required by the API.
status	string	No	Status of an outbound message: queued or sent.
todate	string	No	Filter messages up to the date specified. Format: YYYY-MM-DD (e.g. 2014-02-01).
fromdate	string	No	Filter messages starting from the date specified. Format: YYYY-MM-DD (e.g. 2014-02-01).
fromemail	string	No	Filter by the sender email address.
recipient	string	No	Filter by the user who was receiving the email.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Send Batch Templated Emails

POSTMARK_SEND_BATCH_WITH_TEMPLATES

Tool to send multiple templated emails in a single batch API call. Use when you need to send up to 500 templated messages at once.

Input parameters

Name	Type	Required	Description
Messages	array	Yes	List of templated messages to send (max 500)

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Unarchive Message Stream

POSTMARK_UNARCHIVE_MESSAGE_STREAM

Tool to unarchive a previously archived message stream. Use when you need to restore an archived stream (within 45 days of archiving).

Input parameters

Name	Type	Required	Description
stream_id	string	Yes	The ID of the message stream to unarchive. Must be archived within the last 45 days.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Update Message Stream

POSTMARK_UPDATE_MESSAGE_STREAM

Tool to update a message stream configuration in Postmark. Use when you need to modify a stream’s name or description. Note that stream type and ID cannot be changed after creation.

Input parameters

Name	Type	Required	Description
Name	string	No	The name of the message stream
stream_ID	string	Yes	The ID of the message stream to update
Description	string	No	The description of the message stream

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not

Validate Template

POSTMARK_VALIDATE_TEMPLATE

Tool to validate a Postmark template. Use when checking that a template’s subject and body render correctly against sample data.

Input parameters

Name	Type	Required	Description
Subject	string	No	The subject line of the template.
HtmlBody	string	No	The HTML content of the template.
TextBody	string	No	The plain-text content of the template.
TemplateType	string	Yes	Type of the template, either Standard or Layout.
TestRenderModel	object	Yes	Mock data used to render and validate the template.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution
error	string	No	Error if any occurred during the execution of the action
successful	boolean	Yes	Whether or not the action execution was successful or not