/postmark | Type: Application | PCID required: Yes
Tools
postmark_activate_bounce
Activate a bounce Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bounceid | integer | Yes | — | The ID of the Bounce to activate. |
postmark_bypass_rules_for_inbound_message
Bypass rules for a blocked inbound message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the message which should bypass inbound rules. |
postmark_create_inbound_rule
Create an inbound rule trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | No | — | The body value |
postmark_create_template
Create a Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | The contents required for creating a new template. |
postmark_delete_inbound_rule
Delete a single trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
triggerid | integer | Yes | — | The ID of the Inbound Rule that should be deleted. |
postmark_delete_template
Delete a Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateIdOrAlias | string | Yes | — | The ‘TemplateID’ or ‘Alias’ value for the Template you wish to delete. |
postmark_edit_current_server_configuration
Edit Server Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | No | — | The settings that should be modified for the current server. |
postmark_get_bounce_counts
Get bounce counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_bounce_dump
Get bounce dump Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bounceid | integer | Yes | — | The ID for the bounce dump to retrieve. |
postmark_get_bounces
Get bounces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of bounces to return per request. Max 500. |
offset | integer | Yes | — | Number of bounces to skip. |
type | string | No | — | Filter by type of bounce |
inactive | boolean | No | — | 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. |
emailFilter | string | No | — | Filter by email address |
messageID | string | No | — | Filter by messageID |
tag | string | No | — | Filter by tag |
todate | string | No | — | Filter messages up to the date specified. e.g. 2014-02-01 |
fromdate | string | No | — | Filter messages starting from the date specified. e.g. 2014-02-01 |
postmark_get_clicks_for_single_outbound_message
Retrieve Message Clicks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the Outbound Message for which click statistics should be retrieved. |
count | integer | Yes | — | Number of message clicks to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip. |
postmark_get_current_server_configuration
Get Server Configurationpostmark_get_delivery_stats
Get delivery statspostmark_get_inbound_message_details
Inbound message details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the message for which to details will be retrieved. |
postmark_get_opens_for_single_outbound_message
Retrieve Message Opens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the Outbound Message for which open statistics should be retrieved. |
count | integer | Yes | — | Number of message opens to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip. |
postmark_get_outbound_click_counts
Get click counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_click_counts_by_location
Get clicks by body location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_click_counts_by_platform
Get browser plaform usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_message_details
Outbound message details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the message for which to retrieve details. |
postmark_get_outbound_message_dump
Outbound message dump Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the message for which to retrieve a dump. |
postmark_get_outbound_open_counts
Get email open counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_open_counts_by_email_client
Get email client usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_open_counts_by_platform
Get email platform usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_outbound_overview_statistics
Get outbound overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_sent_counts
Get sent counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_single_bounce
Get a single bounce Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bounceid | integer | Yes | — | The ID of the bounce to retrieve. |
postmark_get_single_template
Get a Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateIdOrAlias | string | Yes | — | The ‘TemplateID’ or ‘Alias’ value for the Template you wish to retrieve. |
postmark_get_spam_complaints
Get spam complaints Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats up to the date specified. e.g. 2014-02-01 |
postmark_get_tracked_email_counts
Get tracked email counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Filter by tag |
fromdate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
todate | string | No | — | Filter stats starting from the date specified. e.g. 2014-01-01 |
postmark_list_inbound_rules
List inbound rule triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of records to return per request. |
offset | integer | Yes | — | Number of records to skip. |
postmark_list_templates
Get the Templates associated with this Server Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Count | number | Yes | — | The number of Templates to return |
Offset | number | Yes | — | The number of Templates to “skip” before returning results. |
postmark_retry_inbound_message_processing
Retry a failed inbound message for processing Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageid | string | Yes | — | The ID of the inbound message on which we should retry processing. |
postmark_search_clicks_for_outbound_messages
Clicks for a all messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of message clicks to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip |
recipient | string | No | — | Filter by To, Cc, Bcc |
tag | string | No | — | Filter by tag |
client_name | string | No | — | Filter by client name, i.e. Outlook, Gmail |
client_company | string | No | — | Filter by company, i.e. Microsoft, Apple, Google |
client_family | string | No | — | Filter by client family, i.e. OS X, Chrome |
os_name | string | No | — | Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7 |
os_family | string | No | — | Filter by kind of OS used without specific version, i.e. OS X, Windows |
os_company | string | No | — | Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation |
platform | string | No | — | Filter by platform, i.e. webmail, desktop, mobile |
country | string | No | — | Filter by country messages were opened in, i.e. Denmark, Russia |
region | string | No | — | Filter by full name of region messages were opened in, i.e. Moscow, New York |
city | string | No | — | Filter by full name of region messages were opened in, i.e. Moscow, New York |
postmark_search_inbound_messages
Inbound message search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of messages to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip |
recipient | string | No | — | Filter by the user who was receiving the email |
fromemail | string | No | — | Filter by the sender email address |
subject | string | No | — | Filter by email subject |
mailboxhash | string | No | — | Filter by mailboxhash |
tag | string | No | — | Filter by tag |
status | string | No | — | Filter by status (blocked, processed, queued, failed, scheduled) |
todate | string | No | — | Filter messages up to the date specified. e.g. 2014-02-01 |
fromdate | string | No | — | Filter messages starting from the date specified. e.g. 2014-02-01 |
postmark_search_opens_for_outbound_messages
Opens for all messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of message opens to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip |
recipient | string | No | — | Filter by To, Cc, Bcc |
tag | string | No | — | Filter by tag |
client_name | string | No | — | Filter by client name, i.e. Outlook, Gmail |
client_company | string | No | — | Filter by company, i.e. Microsoft, Apple, Google |
client_family | string | No | — | Filter by client family, i.e. OS X, Chrome |
os_name | string | No | — | Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7 |
os_family | string | No | — | Filter by kind of OS used without specific version, i.e. OS X, Windows |
os_company | string | No | — | Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation |
platform | string | No | — | Filter by platform, i.e. webmail, desktop, mobile |
country | string | No | — | Filter by country messages were opened in, i.e. Denmark, Russia |
region | string | No | — | Filter by full name of region messages were opened in, i.e. Moscow, New York |
city | string | No | — | Filter by full name of region messages were opened in, i.e. Moscow, New York |
postmark_search_outbound_messages
Outbound message search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | Yes | — | Number of messages to return per request. Max 500. |
offset | integer | Yes | — | Number of messages to skip |
recipient | string | No | — | Filter by the user who was receiving the email |
fromemail | string | No | — | Filter by the sender email address |
tag | string | No | — | Filter by tag |
status | string | No | — | Filter by status (queued or sent) |
todate | string | No | — | Filter messages up to the date specified. e.g. 2014-02-01 |
fromdate | string | No | — | Filter messages starting from the date specified. e.g. 2014-02-01 |
postmark_send_email
Send a single email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | No | — | Request body |
postmark_send_email_batch
Send a batch of emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | any[] | No | — | Request body |
postmark_send_email_batch_with_templates
Send a batch of email using templates. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
postmark_send_email_with_template
Send an email using a Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
postmark_test_template_content
Test Template Content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | No | — | Request body |
postmark_update_template
Update a Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateIdOrAlias | string | Yes | — | The ‘TemplateID’ or ‘Alias’ value for the Template you wish to update. |
body | object | Yes | — | The contents required for creating a new template. |

