Postmark integration (Communication, Marketing). Imported from open-connector.
https://api.postmarkapp.com/server
| Param | Type | Required | Description |
|---|---|---|---|
| From | string | required | Sender email address or full formatted sender string accepted by Postmark. |
| To | string | required | Recipient email address string. Multiple recipients are comma separated. |
| Cc | string | optional | Cc recipient email address string. |
| Bcc | string | optional | Bcc recipient email address string. |
| Tag | string | optional | Email tag used for categorization and analytics. |
| ReplyTo | string | optional | Reply-To email address override. |
| Headers | array | optional | Custom headers to include on the email. |
| TrackOpens | boolean | optional | Whether open tracking is enabled. |
| TrackLinks | string | optional | Link tracking mode recognized by the official Postmark API. |
| Attachments | array | optional | Attachments to include on the email. |
| Metadata | object | optional | Custom metadata key-value pairs attached to the message. |
| MessageStream | string | optional | Message stream ID to use when sending the email. |
| Subject | string | required | Email subject line. |
| HtmlBody | string | optional | HTML body content of the email. |
| TextBody | string | optional | Plain-text body content of the email. |
/email/withTemplate
| Param | Type | Required | Description |
|---|---|---|---|
| TemplateId | integer | optional | Template ID to use when rendering this message. |
| TemplateAlias | string | optional | Template alias to use when rendering this message. |
| TemplateModel | object | required | Additional upstream fields returned by Postmark. |
| InlineCss | boolean | optional | Whether CSS blocks should be inlined into rendered HTML content. |
| From | string | required | Sender email address or full formatted sender string accepted by Postmark. |
| To | string | required | Recipient email address string. Multiple recipients are comma separated. |
| Cc | string | optional | Cc recipient email address string. |
| Bcc | string | optional | Bcc recipient email address string. |
| Tag | string | optional | Email tag used for categorization and analytics. |
| ReplyTo | string | optional | Reply-To email address override. |
| Headers | array | optional | Custom headers to include on the email. |
| TrackOpens | boolean | optional | Whether open tracking is enabled. |
| TrackLinks | string | optional | Link tracking mode recognized by the official Postmark API. |
| Attachments | array | optional | Attachments to include on the email. |
| Metadata | object | optional | Custom metadata key-value pairs attached to the message. |
| MessageStream | string | optional | Message stream ID to use when sending the email. |
/email/batchWithTemplates
| Param | Type | Required | Description |
|---|---|---|---|
| Messages | array | optional | Templated messages to send in this batch request. |
/messages/outbound
| Param | Type | Required | Description |
|---|---|---|---|
| count | integer | optional | Number of results to return per request. |
| offset | integer | optional | Number of results to skip before returning the current page. |
| recipient | string | optional | Filter by the user who was receiving the email. |
| fromemail | string | optional | Filter by the sender email address. |
| tag | string | optional | Filter by message tag. |
| status | string | optional | Outbound message status filter accepted by Postmark search. |
| todate | string | optional | Filter messages up to this datetime, inclusive. |
| fromdate | string | optional | Filter messages starting from this datetime, inclusive. |
| subject | string | optional | Filter by email subject. |
| messagestream | string | optional | Filter by message stream ID. |
| metadata | object | optional | Metadata filters mapped to Postmark metadata_<key> query parameters for outboun… |
/messages/outbound/{messageId}/details
| Param | Type | Required | Description |
|---|---|---|---|
| messageId | string | required | Outbound message ID returned by Postmark. |
/bounces
| Param | Type | Required | Description |
|---|---|---|---|
| count | integer | optional | Number of results to return per request. |
| offset | integer | optional | Number of results to skip before returning the current page. |
| type | string | optional | Filter by bounce type. |
| inactive | boolean | optional | Whether to return only inactive bounces. |
| emailFilter | string | optional | Filter by bounced email address. |
| messageID | string | optional | Filter by outbound message ID. |
| mailboxHash | string | optional | Filter by the mailbox hash portion of the address. |
| tag | string | optional | Filter by tag. |
| todate | string | optional | Only include bounces before this datetime. |
| fromdate | string | optional | Only include bounces after this datetime. |
/templates
| Param | Type | Required | Description |
|---|---|---|---|
| count | integer | optional | Number of results to return per request. |
| offset | integer | optional | Number of results to skip before returning the current page. |
| TemplateType | string | optional | Template type recognized by the official Postmark API. |
| LayoutTemplate | string | optional | Filter by layout template alias. |
/templates/{templateIdOrAlias}
| Param | Type | Required | Description |
|---|---|---|---|
| templateIdOrAlias | integer | required | Template ID or template alias accepted by the Postmark path parameter. |
/templates
| Param | Type | Required | Description |
|---|---|---|---|
| Name | string | required | Template name. |
| Subject | string | optional | Subject content for the template. Required for standard templates. |
| HtmlBody | string | optional | HTML body content of the template. |
| TextBody | string | optional | Plain-text body content of the template. |
| TemplateType | string | optional | Template type recognized by the official Postmark API. |
| Alias | string | optional | Optional alias that identifies the template within the server. |
| LayoutTemplate | string | optional | Optional layout template alias used by a standard template. |
/templates/{templateIdOrAlias}
| Param | Type | Required | Description |
|---|---|---|---|
| templateIdOrAlias | integer | required | Template ID or template alias accepted by the Postmark path parameter. |
| Name | string | required | Updated template name. |
| Subject | string | optional | Updated template subject content when the template is standard. |
| HtmlBody | string | optional | Updated HTML body content. |
| TextBody | string | optional | Updated plain-text body content. |
| Alias | string | optional | Updated alias that identifies the template within the server. |
| LayoutTemplate | string | optional | Updated layout template alias for a standard template. |
/templates/validate
| Param | Type | Required | Description |
|---|---|---|---|
| Subject | string | optional | Subject content to validate against Postmark template syntax. |
| HtmlBody | string | optional | HTML body content to validate. |
| TextBody | string | optional | Plain-text body content to validate. |
| TestRenderModel | object | required | Additional upstream fields returned by Postmark. |
| InlineCssForHtmlTestRender | boolean | optional | Whether CSS blocks should be inlined when rendering HTML test output. |
| TemplateType | string | optional | Template type recognized by the official Postmark API. |
| LayoutTemplate | string | optional | Optional layout template alias used while validating a standard template. |