← Tools Reference

Postmark

Postmark integration (Communication, Marketing). Imported from open-connector.

API key12 toolshttps://api.postmarkapp.com
GET
postmark_get_server
Get the current Postmark server configuration for the connected server token.

/server

POST
postmark_send_email
Send a transactional email through the current Postmark server.

/email

15 parameters
ParamTypeRequiredDescription
FromstringrequiredSender email address or full formatted sender string accepted by Postmark.
TostringrequiredRecipient email address string. Multiple recipients are comma separated.
CcstringoptionalCc recipient email address string.
BccstringoptionalBcc recipient email address string.
TagstringoptionalEmail tag used for categorization and analytics.
ReplyTostringoptionalReply-To email address override.
HeadersarrayoptionalCustom headers to include on the email.
TrackOpensbooleanoptionalWhether open tracking is enabled.
TrackLinksstringoptionalLink tracking mode recognized by the official Postmark API.
AttachmentsarrayoptionalAttachments to include on the email.
MetadataobjectoptionalCustom metadata key-value pairs attached to the message.
MessageStreamstringoptionalMessage stream ID to use when sending the email.
SubjectstringrequiredEmail subject line.
HtmlBodystringoptionalHTML body content of the email.
TextBodystringoptionalPlain-text body content of the email.
POST
postmark_send_email_with_template
Send a single templated email through the current Postmark server.

/email/withTemplate

16 parameters
ParamTypeRequiredDescription
TemplateIdintegeroptionalTemplate ID to use when rendering this message.
TemplateAliasstringoptionalTemplate alias to use when rendering this message.
TemplateModelobjectrequiredAdditional upstream fields returned by Postmark.
InlineCssbooleanoptionalWhether CSS blocks should be inlined into rendered HTML content.
FromstringrequiredSender email address or full formatted sender string accepted by Postmark.
TostringrequiredRecipient email address string. Multiple recipients are comma separated.
CcstringoptionalCc recipient email address string.
BccstringoptionalBcc recipient email address string.
TagstringoptionalEmail tag used for categorization and analytics.
ReplyTostringoptionalReply-To email address override.
HeadersarrayoptionalCustom headers to include on the email.
TrackOpensbooleanoptionalWhether open tracking is enabled.
TrackLinksstringoptionalLink tracking mode recognized by the official Postmark API.
AttachmentsarrayoptionalAttachments to include on the email.
MetadataobjectoptionalCustom metadata key-value pairs attached to the message.
MessageStreamstringoptionalMessage stream ID to use when sending the email.
POST
postmark_send_batch_with_templates
Send up to 500 templated emails in a single Postmark batch request.

/email/batchWithTemplates

1 parameter
ParamTypeRequiredDescription
MessagesarrayoptionalTemplated messages to send in this batch request.
GET
postmark_search_outbound_messages
Search outbound Postmark messages with filters and pagination.

/messages/outbound

11 parameters
ParamTypeRequiredDescription
countintegeroptionalNumber of results to return per request.
offsetintegeroptionalNumber of results to skip before returning the current page.
recipientstringoptionalFilter by the user who was receiving the email.
fromemailstringoptionalFilter by the sender email address.
tagstringoptionalFilter by message tag.
statusstringoptionalOutbound message status filter accepted by Postmark search.
todatestringoptionalFilter messages up to this datetime, inclusive.
fromdatestringoptionalFilter messages starting from this datetime, inclusive.
subjectstringoptionalFilter by email subject.
messagestreamstringoptionalFilter by message stream ID.
metadataobjectoptionalMetadata filters mapped to Postmark metadata_<key> query parameters for outboun…
GET
postmark_get_outbound_message_details
Get detailed content and events for one outbound Postmark message.

/messages/outbound/{messageId}/details

1 parameter
ParamTypeRequiredDescription
messageIdstringrequiredOutbound message ID returned by Postmark.
GET
postmark_get_bounces
Get Postmark bounces for the current server with optional filters.

/bounces

10 parameters
ParamTypeRequiredDescription
countintegeroptionalNumber of results to return per request.
offsetintegeroptionalNumber of results to skip before returning the current page.
typestringoptionalFilter by bounce type.
inactivebooleanoptionalWhether to return only inactive bounces.
emailFilterstringoptionalFilter by bounced email address.
messageIDstringoptionalFilter by outbound message ID.
mailboxHashstringoptionalFilter by the mailbox hash portion of the address.
tagstringoptionalFilter by tag.
todatestringoptionalOnly include bounces before this datetime.
fromdatestringoptionalOnly include bounces after this datetime.
GET
postmark_list_templates
List Postmark templates for the current server.

/templates

4 parameters
ParamTypeRequiredDescription
countintegeroptionalNumber of results to return per request.
offsetintegeroptionalNumber of results to skip before returning the current page.
TemplateTypestringoptionalTemplate type recognized by the official Postmark API.
LayoutTemplatestringoptionalFilter by layout template alias.
GET
postmark_get_template
Get one Postmark template by template ID or alias.

/templates/{templateIdOrAlias}

1 parameter
ParamTypeRequiredDescription
templateIdOrAliasintegerrequiredTemplate ID or template alias accepted by the Postmark path parameter.
POST
postmark_create_template
Create a Postmark template.

/templates

7 parameters
ParamTypeRequiredDescription
NamestringrequiredTemplate name.
SubjectstringoptionalSubject content for the template. Required for standard templates.
HtmlBodystringoptionalHTML body content of the template.
TextBodystringoptionalPlain-text body content of the template.
TemplateTypestringoptionalTemplate type recognized by the official Postmark API.
AliasstringoptionalOptional alias that identifies the template within the server.
LayoutTemplatestringoptionalOptional layout template alias used by a standard template.
PUT
postmark_edit_template
Edit an existing Postmark template.

/templates/{templateIdOrAlias}

7 parameters
ParamTypeRequiredDescription
templateIdOrAliasintegerrequiredTemplate ID or template alias accepted by the Postmark path parameter.
NamestringrequiredUpdated template name.
SubjectstringoptionalUpdated template subject content when the template is standard.
HtmlBodystringoptionalUpdated HTML body content.
TextBodystringoptionalUpdated plain-text body content.
AliasstringoptionalUpdated alias that identifies the template within the server.
LayoutTemplatestringoptionalUpdated layout template alias for a standard template.
POST
postmark_validate_template
Validate Postmark template content and render test output.

/templates/validate

7 parameters
ParamTypeRequiredDescription
SubjectstringoptionalSubject content to validate against Postmark template syntax.
HtmlBodystringoptionalHTML body content to validate.
TextBodystringoptionalPlain-text body content to validate.
TestRenderModelobjectrequiredAdditional upstream fields returned by Postmark.
InlineCssForHtmlTestRenderbooleanoptionalWhether CSS blocks should be inlined when rendering HTML test output.
TemplateTypestringoptionalTemplate type recognized by the official Postmark API.
LayoutTemplatestringoptionalOptional layout template alias used while validating a standard template.