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

