Skip to main content
Server path: /postmark | Type: Application | PCID required: Yes

Tools

ToolDescription
postmark_activate_bounceActivate a bounce
postmark_bypass_rules_for_inbound_messageBypass rules for a blocked inbound message
postmark_create_inbound_ruleCreate an inbound rule trigger
postmark_create_templateCreate a Template
postmark_delete_inbound_ruleDelete a single trigger
postmark_delete_templateDelete a Template
postmark_edit_current_server_configurationEdit Server Configuration
postmark_get_bounce_countsGet bounce counts
postmark_get_bounce_dumpGet bounce dump
postmark_get_bouncesGet bounces
postmark_get_clicks_for_single_outbound_messageRetrieve Message Clicks
postmark_get_current_server_configurationGet Server Configuration
postmark_get_delivery_statsGet delivery stats
postmark_get_inbound_message_detailsInbound message details
postmark_get_opens_for_single_outbound_messageRetrieve Message Opens
postmark_get_outbound_click_countsGet click counts
postmark_get_outbound_click_counts_by_browser_familyGet browser usage by family
postmark_get_outbound_click_counts_by_locationGet clicks by body location
postmark_get_outbound_click_counts_by_platformGet browser plaform usage
postmark_get_outbound_message_detailsOutbound message details
postmark_get_outbound_message_dumpOutbound message dump
postmark_get_outbound_open_countsGet email open counts
postmark_get_outbound_open_counts_by_email_clientGet email client usage
postmark_get_outbound_open_counts_by_platformGet email platform usage
postmark_get_outbound_overview_statisticsGet outbound overview
postmark_get_sent_countsGet sent counts
postmark_get_single_bounceGet a single bounce
postmark_get_single_templateGet a Template
postmark_get_spam_complaintsGet spam complaints
postmark_get_tracked_email_countsGet tracked email counts
postmark_list_inbound_rulesList inbound rule triggers
postmark_list_templatesGet the Templates associated with this Server
postmark_retry_inbound_message_processingRetry a failed inbound message for processing
postmark_search_clicks_for_outbound_messagesClicks for a all messages
postmark_search_inbound_messagesInbound message search
postmark_search_opens_for_outbound_messagesOpens for all messages
postmark_search_outbound_messagesOutbound message search
postmark_send_emailSend a single email
postmark_send_email_batchSend a batch of emails
postmark_send_email_batch_with_templatesSend a batch of email using templates.
postmark_send_email_with_templateSend an email using a Template
postmark_test_template_contentTest Template Content
postmark_update_templateUpdate a Template

postmark_activate_bounce

Activate a bounce Parameters:
ParameterTypeRequiredDefaultDescription
bounceidintegerYesThe ID of the Bounce to activate.

postmark_bypass_rules_for_inbound_message

Bypass rules for a blocked inbound message Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the message which should bypass inbound rules.

postmark_create_inbound_rule

Create an inbound rule trigger Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoThe body value

postmark_create_template

Create a Template Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesThe contents required for creating a new template.

postmark_delete_inbound_rule

Delete a single trigger Parameters:
ParameterTypeRequiredDefaultDescription
triggeridintegerYesThe ID of the Inbound Rule that should be deleted.

postmark_delete_template

Delete a Template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdOrAliasstringYesThe ‘TemplateID’ or ‘Alias’ value for the Template you wish to delete.

postmark_edit_current_server_configuration

Edit Server Configuration Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoThe settings that should be modified for the current server.

postmark_get_bounce_counts

Get bounce counts Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_bounce_dump

Get bounce dump Parameters:
ParameterTypeRequiredDefaultDescription
bounceidintegerYesThe ID for the bounce dump to retrieve.

postmark_get_bounces

Get bounces Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of bounces to return per request. Max 500.
offsetintegerYesNumber of bounces to skip.
typestringNoFilter by type of bounce
inactivebooleanNoFilter 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.
emailFilterstringNoFilter by email address
messageIDstringNoFilter by messageID
tagstringNoFilter by tag
todatestringNoFilter messages up to the date specified. e.g. 2014-02-01
fromdatestringNoFilter messages starting from the date specified. e.g. 2014-02-01

postmark_get_clicks_for_single_outbound_message

Retrieve Message Clicks Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the Outbound Message for which click statistics should be retrieved.
countintegerYesNumber of message clicks to return per request. Max 500.
offsetintegerYesNumber of messages to skip.

postmark_get_current_server_configuration

Get Server Configuration

postmark_get_delivery_stats

Get delivery stats

postmark_get_inbound_message_details

Inbound message details Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the message for which to details will be retrieved.

postmark_get_opens_for_single_outbound_message

Retrieve Message Opens Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the Outbound Message for which open statistics should be retrieved.
countintegerYesNumber of message opens to return per request. Max 500.
offsetintegerYesNumber of messages to skip.

postmark_get_outbound_click_counts

Get click counts Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_click_counts_by_browser_family

Get browser usage by family Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_click_counts_by_location

Get clicks by body location Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_click_counts_by_platform

Get browser plaform usage Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_message_details

Outbound message details Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the message for which to retrieve details.

postmark_get_outbound_message_dump

Outbound message dump Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the message for which to retrieve a dump.

postmark_get_outbound_open_counts

Get email open counts Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_open_counts_by_email_client

Get email client usage Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_open_counts_by_platform

Get email platform usage Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_outbound_overview_statistics

Get outbound overview Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_sent_counts

Get sent counts Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_single_bounce

Get a single bounce Parameters:
ParameterTypeRequiredDefaultDescription
bounceidintegerYesThe ID of the bounce to retrieve.

postmark_get_single_template

Get a Template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdOrAliasstringYesThe ‘TemplateID’ or ‘Alias’ value for the Template you wish to retrieve.

postmark_get_spam_complaints

Get spam complaints Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats up to the date specified. e.g. 2014-02-01

postmark_get_tracked_email_counts

Get tracked email counts Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoFilter by tag
fromdatestringNoFilter stats starting from the date specified. e.g. 2014-01-01
todatestringNoFilter stats starting from the date specified. e.g. 2014-01-01

postmark_list_inbound_rules

List inbound rule triggers Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of records to return per request.
offsetintegerYesNumber of records to skip.

postmark_list_templates

Get the Templates associated with this Server Parameters:
ParameterTypeRequiredDefaultDescription
CountnumberYesThe number of Templates to return
OffsetnumberYesThe number of Templates to “skip” before returning results.

postmark_retry_inbound_message_processing

Retry a failed inbound message for processing Parameters:
ParameterTypeRequiredDefaultDescription
messageidstringYesThe ID of the inbound message on which we should retry processing.

postmark_search_clicks_for_outbound_messages

Clicks for a all messages Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of message clicks to return per request. Max 500.
offsetintegerYesNumber of messages to skip
recipientstringNoFilter by To, Cc, Bcc
tagstringNoFilter by tag
client_namestringNoFilter by client name, i.e. Outlook, Gmail
client_companystringNoFilter by company, i.e. Microsoft, Apple, Google
client_familystringNoFilter by client family, i.e. OS X, Chrome
os_namestringNoFilter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7
os_familystringNoFilter by kind of OS used without specific version, i.e. OS X, Windows
os_companystringNoFilter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation
platformstringNoFilter by platform, i.e. webmail, desktop, mobile
countrystringNoFilter by country messages were opened in, i.e. Denmark, Russia
regionstringNoFilter by full name of region messages were opened in, i.e. Moscow, New York
citystringNoFilter by full name of region messages were opened in, i.e. Moscow, New York

postmark_search_inbound_messages

Inbound message search Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of messages to return per request. Max 500.
offsetintegerYesNumber of messages to skip
recipientstringNoFilter by the user who was receiving the email
fromemailstringNoFilter by the sender email address
subjectstringNoFilter by email subject
mailboxhashstringNoFilter by mailboxhash
tagstringNoFilter by tag
statusstringNoFilter by status (blocked, processed, queued, failed, scheduled)
todatestringNoFilter messages up to the date specified. e.g. 2014-02-01
fromdatestringNoFilter messages starting from the date specified. e.g. 2014-02-01

postmark_search_opens_for_outbound_messages

Opens for all messages Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of message opens to return per request. Max 500.
offsetintegerYesNumber of messages to skip
recipientstringNoFilter by To, Cc, Bcc
tagstringNoFilter by tag
client_namestringNoFilter by client name, i.e. Outlook, Gmail
client_companystringNoFilter by company, i.e. Microsoft, Apple, Google
client_familystringNoFilter by client family, i.e. OS X, Chrome
os_namestringNoFilter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7
os_familystringNoFilter by kind of OS used without specific version, i.e. OS X, Windows
os_companystringNoFilter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation
platformstringNoFilter by platform, i.e. webmail, desktop, mobile
countrystringNoFilter by country messages were opened in, i.e. Denmark, Russia
regionstringNoFilter by full name of region messages were opened in, i.e. Moscow, New York
citystringNoFilter by full name of region messages were opened in, i.e. Moscow, New York

postmark_search_outbound_messages

Outbound message search Parameters:
ParameterTypeRequiredDefaultDescription
countintegerYesNumber of messages to return per request. Max 500.
offsetintegerYesNumber of messages to skip
recipientstringNoFilter by the user who was receiving the email
fromemailstringNoFilter by the sender email address
tagstringNoFilter by tag
statusstringNoFilter by status (queued or sent)
todatestringNoFilter messages up to the date specified. e.g. 2014-02-01
fromdatestringNoFilter messages starting from the date specified. e.g. 2014-02-01

postmark_send_email

Send a single email Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoRequest body

postmark_send_email_batch

Send a batch of emails Parameters:
ParameterTypeRequiredDefaultDescription
bodyany[]NoRequest body

postmark_send_email_batch_with_templates

Send a batch of email using templates. Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

postmark_send_email_with_template

Send an email using a Template Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

postmark_test_template_content

Test Template Content Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoRequest body

postmark_update_template

Update a Template Parameters:
ParameterTypeRequiredDefaultDescription
templateIdOrAliasstringYesThe ‘TemplateID’ or ‘Alias’ value for the Template you wish to update.
bodyobjectYesThe contents required for creating a new template.