Schemas
ActivateBounceResponse
MessageResult of the reactivation attempt.
A bounce record.
ArchiveMessageStreamResponse
IDID of the archived stream.
ServerIDID of the server.
ExpectedPurgeDateDate the archived stream will be permanently deleted unless unarchived.
Attachment
NameFile name shown to the recipient, including extension.
ContentBase64-encoded file content.
ContentTypeMIME type of the attachment.
ContentIDContent-ID used to embed the attachment inline, e.g. cid:logo.png. Reference the same value from the HTML body (<img src="cid:logo.png">).
Bounce
IDUnique ID of the bounce. Field of Bounce.
TypeType of bounce. See the Bounce types section of the Postmark docs for what each value means.
TypeCodeNumeric code of the bounce type.
NameDisplay name of the bounce type.
TagTag of the bounced message.
MessageIDID of the message that bounced.
ServerIDID of the server that sent the message.
MessageStreamMessage stream the message was sent through.
DescriptionShort description of the bounce reason.
DetailsDetailed reason reported by the receiving server.
EmailEmail address that bounced.
FromSender address of the bounced message.
BouncedAtTime the bounce occurred.
DumpAvailableWhether the raw SMTP dump is available (see Get bounce dump).
InactiveWhether Postmark deactivated the address because of this bounce.
CanActivateWhether the address can be reactivated.
SubjectSubject of the bounced message.
ContentRaw content of the bounce. Only returned when fetching a single bounce.
BounceCountsStats
Per-day breakdown: bounce counts per day by type.
HardBounceTotal hard bounces.
SMTPApiErrorTotal SMTP API errors.
SoftBounceTotal soft bounces.
TransientTotal transient bounces.
BounceDump
BodyRaw SMTP source of the bounce. Empty string when no dump is available.
BounceList
TotalCountNumber of bounces matching the search. May exceed the number returned in one call.
Bounces for the requested page.
BounceType
Type of bounce. See the Bounce types section of the Postmark docs for what each value means.
BounceWebhookPayload
RecordTypeAlways Bounce.
MessageIDUnique ID of the message.
IDUnique ID of the bounce. Field of BounceWebhookPayload.
EmailAddress that bounced.
MessageStreamMessage stream the message was sent through.
TagTag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
TypeBounce type.
TypeCodeNumeric bounce type code.
NameBounce type display name.
DescriptionShort reason for the bounce.
DetailsDetailed reason from the receiving server.
FromSender address.
BouncedAtBounce time.
DumpAvailableWhether the SMTP dump can be fetched.
InactiveWhether the address was deactivated.
CanActivateWhether the address can be reactivated.
SubjectSubject of the original message.
ServerIDID of the server. Field of BounceWebhookPayload.
ContentFull bounce content. Only present if IncludeContent is enabled.
BrowserFamilyStats
Per-day breakdown: clicks per browser family, per day.
Total clicks for this browser family.
BulkEmailRequest
FromSender email address. Must belong to a confirmed Sender Signature.
Recipients and their per-message data.
ReplyToReply-To override.
SubjectEmail subject. May contain template variables.
HtmlBodyHTML body. Required if no TextBody or template is given.
TextBodyPlain-text body. Required if no HtmlBody or template is given.
TemplateIdID of a hosted template. Alternative to submitting content inline.
TemplateAliasAlias of a hosted template. Alternative to submitting content inline.
InlineCssInline <style> blocks of the template into the HTML. Defaults to true.
TagTag used to categorize messages. Max 1000 characters.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the broadcast message stream. Defaults to the outbound broadcast stream.
TrackOpensEnable open tracking.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files attached to every message.
Custom headers applied to every message.
BulkMessage
ToRecipient email addresses, comma separated. Max 50.
CcCc recipient email addresses, comma separated. Max 50.
BccBcc recipient email addresses, comma separated. Max 50.
Recipient-specific template variables.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
Custom headers for this recipient. Take precedence over request-level headers.
BulkRequestList
Bulk requests submitted on this server, newest first.
PaginationKeyOpaque cursor for the next page. Pass it back unchanged as paginationKey. Absent on the last page.
BulkRequestStatus
IdID of the bulk request.
StatusProcessing status of the request.
SubmittedAtTime Postmark received the request.
TotalMessagesTotal number of messages in the request.
PercentageCompleted0-100 value showing how much of the request Postmark has finished. 100 means processing finished, not that every message was delivered.
ReleasedCountMessages handed to the sending pipeline so far. Released is not the same as delivered.
FailedCountMessages that will not be delivered or retried (for example suppressed recipients or template render failures).
SubjectEmail subject. Omitted when the request had none.
ClickCountsStats
Per-day breakdown: click counts per day.
TotalClicksTotal clicks.
UniqueTotal unique clicks.
ClickEvent
RecordTypeType of record.
Email client (or browser) details detected from the user agent.
Operating system details detected from the user agent.
PlatformPlatform the email was opened or clicked on.
UserAgentFull user-agent header from the client.
Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.
MessageIDUnique ID of the message.
MessageStreamMessage stream the message was sent through.
ReceivedAtTime of the event.
Tag of the message.
RecipientRecipient email address.
OriginalLinkThe tracked link that was clicked.
ClickLocationWhere the link appeared in the message.
ClickList
TotalCountNumber of clicks matching the search.
Clicks for the requested page.
ClickLocationStats
Per-day breakdown: clicks per body location per day.
HTMLTotal HTML clicks.
TextTotal text clicks.
ClickPlatformStats
Per-day breakdown: clicks per platform per day.
DesktopTotal desktop clicks.
MobileTotal mobile clicks.
UnknownTotal unknown clicks.
ClickWebhookPayload
RecordTypeAlways Click.
OriginalLinkThe tracked link that was clicked.
MessageIDUnique ID of the message.
RecipientRecipient that clicked.
ClickLocationWhere the link appeared.
Email client (or browser) details detected from the user agent.
Operating system details detected from the user agent.
PlatformPlatform the email was opened or clicked on.
UserAgentFull user-agent header.
Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.
MessageStreamMessage stream the message was sent through.
Tag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
ReceivedAtTime of the click.
Client
NameEmail client or browser name and version.
CompanyCompany that produced the client.
FamilyClient family.
CreateDataRemovalRequest
RequestedByEmail address of the person making the request.
RequestedForEmail address whose data should be removed.
NotifyWhenCompletedEmail RequestedBy when the removal completes.
CreateDomainRequest
NameDomain name to add.
ReturnPathDomainCustom Return-Path subdomain of the domain, with a CNAME pointing to pm.mtasv.net.
CreateInboundRuleRequest
RuleEmail address or domain to block from inbound processing.
CreateMessageStreamRequest
IDUnique stream ID. Starts with a letter, up to 30 characters, must not start with pm-.
NameStream name.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
DescriptionStream description. No HTML.
Unsubscribe handling settings. Relevant to Broadcast streams.
CreateSenderSignatureRequest
FromEmailEmail address of the signature.
NameFrom name.
ReplyToEmailReply-To override address.
ReturnPathDomainCustom Return-Path subdomain with a CNAME to pm.mtasv.net.
ConfirmationPersonalNoteNote shown in the confirmation email. Max 400 characters.
CreateServerRequest
NameServer name.
ColorColor used to identify the server in the Postmark UI.
SmtpApiActivatedWhether sending through SMTP is enabled.
RawEmailEnabledWhether the raw email content is included in inbound webhooks.
InboundHookUrlWebhook URL for inbound messages.
BounceHookUrlWebhook URL for bounces (legacy; prefer the Webhooks API).
OpenHookUrlWebhook URL for opens (legacy; prefer the Webhooks API).
DeliveryHookUrlWebhook URL for deliveries (legacy; prefer the Webhooks API).
ClickHookUrlWebhook URL for clicks (legacy; prefer the Webhooks API).
PostFirstOpenOnlyOnly post the open webhook for the first open of a message.
InboundDomainYour own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.
InboundSpamThresholdSpam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).
TrackOpensTrack opens by default for messages sent from this server.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
IncludeBounceContentInHookInclude the bounce content in bounce webhooks.
EnableSmtpApiErrorHooksPost SMTP API errors to the bounce webhook URL.
DeliveryTypeLive (default) delivers email; Sandbox captures email without delivering it. Cannot be changed after creation.
CreateSuppressionsRequest
Addresses to process. Max 50 per request.
CreateSuppressionsResponse
One result per submitted address.
CreateTemplateRequest
NameTemplate name.
SubjectSubject template. Required for Standard templates.
HtmlBodyHTML body template. HtmlBody or TextBody is required.
TextBodyPlain-text body template.
AliasUnique alias used to reference the template when sending.
TemplateTypeStandard templates render a full message; Layout templates wrap the content of Standard templates.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
CreateTemplateResponse
TemplateIdID of the new template.
Template name.
ActiveWhether the template is active.
Unique alias used to reference the template when sending.
TemplateTypeStandard templates render a full message; Layout templates wrap the content of Standard templates.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
CreateWebhookRequest
UrlURL Postmark posts events to.
MessageStreamStream to attach the webhook to. Defaults to outbound. Cannot be an inbound or archived stream.
HTTP Basic Auth credentials Postmark sends with each webhook request.
Custom HTTP headers to send with each request.
Events a webhook receives. In edit requests, triggers you omit are left unchanged.
VerifyTest the endpoint for each enabled event before saving. Defaults to true. Set false to save unverified; the webhook receives no events until verified.
CustomHeader
NameHeader name.
ValueHeader value.
DataRemovalStatus
IDUnique ID of the data removal request. Field of DataRemovalStatus.
StatusCurrent status of the request.
DeleteSuppressionsRequest
Addresses to process. Max 50 per request. Field of DeleteSuppressionsRequest.
DeleteSuppressionsResponse
One result per submitted address. Field of DeleteSuppressionsResponse.
DeliveryStats
InactiveMailsNumber of addresses currently deactivated because of bounces.
Bounce counts grouped by type. The entry named All is the total.
DeliveryWebhookPayload
RecordTypeAlways Delivery.
MessageIDUnique ID of the message.
RecipientRecipient the message was delivered to.
ServerIDID of the server. Field of BounceWebhookPayload.
MessageStreamMessage stream the message was sent through.
Tag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
DeliveredAtDelivery time.
DetailsDelivery details reported by the receiving server.
Domain
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
DomainList
TotalCountNumber of domains on the account.
Domains for the requested page.
DomainSummary
NameDomain name.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
IDUnique ID of the domain. Field of Domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
EditDomainRequest
ReturnPathDomainNew custom Return-Path subdomain.
EditMessageStreamRequest
NameNew stream name.
DescriptionNew stream description.
Unsubscribe handling settings. Relevant to Broadcast streams.
EditSenderSignatureRequest
NameFrom name. Field of EditSenderSignatureRequest.
ReplyToEmailReply-To override address. Field of EditSenderSignatureRequest.
ReturnPathDomainCustom Return-Path subdomain with a CNAME to pm.mtasv.net.
ConfirmationPersonalNoteNote shown in the confirmation email. Max 400 characters. Field of EditSenderSignatureRequest.
EditServerRequest
Server name.
ColorColor used to identify the server in the Postmark UI.
SmtpApiActivatedWhether sending through SMTP is enabled.
RawEmailEnabledWhether the raw email content is included in inbound webhooks.
InboundHookUrlWebhook URL for inbound messages.
BounceHookUrlWebhook URL for bounces (legacy; prefer the Webhooks API).
OpenHookUrlWebhook URL for opens (legacy; prefer the Webhooks API).
DeliveryHookUrlWebhook URL for deliveries (legacy; prefer the Webhooks API).
ClickHookUrlWebhook URL for clicks (legacy; prefer the Webhooks API).
PostFirstOpenOnlyOnly post the open webhook for the first open of a message.
InboundDomainYour own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.
InboundSpamThresholdSpam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).
TrackOpensTrack opens by default for messages sent from this server.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
IncludeBounceContentInHookInclude the bounce content in bounce webhooks.
EnableSmtpApiErrorHooksPost SMTP API errors to the bounce webhook URL.
EditTemplateRequest
Template name.
SubjectSubject template.
HtmlBodyHTML body template.
TextBodyPlain-text body template.
Unique alias used to reference the template when sending.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
EditWebhookRequest
UrlURL Postmark posts events to.
HTTP Basic Auth credentials Postmark sends with each webhook request.
Custom HTTP headers to send with each request. Field of EditWebhookRequest.
Events a webhook receives. In edit requests, triggers you omit are left unchanged.
Test the endpoint for each enabled event before saving. Defaults to true. Set false to save unverified; the webhook receives no events until verified.
EmailAddress
EmailEmail address. Field of EmailAddress.
NameDisplay name, if any.
EmailClientStats
Per-day breakdown: opens per email client, per day.
Total opens for this email client.
ErrorResponse
ErrorCodePostmark API error code that identifies the type of error. Also echoed in the X-PM-ApiErrorCode response header.
MessageHuman-readable description of the error.
Present when several validation errors occurred (ErrorCode 11, Bulk API). Keys are request field names; values are the errors found for that field.
Geo
CountryISOCodeISO 3166-1 alpha-2 country code.
CountryCountry name.
RegionISOCodeRegion ISO code.
RegionRegion name.
CityCity name.
ZipPostal code.
CoordsLatitude and longitude, comma separated.
IPIP address the event came from.
InboundAddress
EmailEmail address. Field of InboundAddress.
NameDisplay name.
MailboxHashMailbox hash part of the address, if any.
InboundAttachment
NameFile name.
ContentIDContent-ID, empty when not inline.
ContentTypeMIME type.
ContentLengthSize in bytes.
InboundMessageDetails
FromSender email address.
FromNameSender name.
An address on an inbound message.
ToTo recipients as a string.
To recipients.
CcCc recipients as a string.
Cc recipients.
ReplyToReply-To address.
OriginalRecipientReceiver (RCPT TO) address.
SubjectSubject.
DateDate header of the message.
MailboxHashCustom hash the email was sent to.
TagTag.
Attachments.
MessageIDUnique ID of the message. Field of InboundMessageDetails.
StatusMessage status.
TextBodyPlain-text body.
HtmlBodyHTML body.
All message headers.
BlockedReasonReason the message was blocked, when applicable.
InboundMessageList
TotalCountNumber of messages matching the search.
Messages for the requested page.
InboundMessageSummary
Sender email address.
FromNameSender name.
An address on an inbound message.
To recipients as a string.
To recipients. Field of InboundMessageSummary.
Cc recipients as a string.
Cc recipients. Field of InboundMessageSummary.
ReplyToReply-To address.
OriginalRecipientReceiver (RCPT TO) address.
SubjectSubject.
Date header of the message.
MailboxHashCustom hash the email was sent to.
Tag.
Attachments. Field of InboundMessageSummary.
MessageIDUnique ID of the message. Field of InboundMessageDetails.
StatusMessage status.
InboundRule
IDUnique ID of the rule.
RuleEmail address or domain that is blocked.
InboundRuleList
TotalCountNumber of rules on the server.
Rules for the requested page.
MessageDump
BodyRaw source of the message. Empty string when no dump is available.
MessageEvent
RecipientRecipient the event relates to.
TypeEvent type.
ReceivedAtTime of the event. Field of MessageEvent.
Event-specific details, such as DeliveryMessage, DestinationServer, DestinationIP, Summary, BounceID, Link, ClickLocation, Origin or SuppressSending.
MessageStream
IDUnique ID of the stream, used as MessageStream when sending.
ServerIDID of the server the stream belongs to.
Stream name.
DescriptionStream description.
MessageStreamTypeTransactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
CreatedAtCreation time.
UpdatedAtLast update time.
ArchivedAtTime the stream was archived, if archived.
ExpectedPurgeDateDate an archived stream will be permanently deleted.
Unsubscribe handling settings. Relevant to Broadcast streams.
MessageStreamList
TotalCountNumber of streams matching the request.
Streams on the server.
MessageStreamType
Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.
Metadata
OpenCountsStats
Per-day breakdown: open counts per day.
OpensTotal opens.
UniqueTotal unique opens.
OpenEvent
RecordTypeType of record. Field of OpenEvent.
Email client (or browser) details detected from the user agent.
Operating system details detected from the user agent.
PlatformPlatform the email was opened or clicked on.
UserAgentFull user-agent header from the client.
Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.
MessageIDUnique ID of the message.
MessageStreamMessage stream the message was sent through.
ReceivedAtTime of the event.
Tag of the message.
RecipientRecipient email address.
OpenList
TotalCountNumber of opens matching the search.
Opens for the requested page.
OpenPlatformStats
Per-day breakdown: opens per platform per day.
DesktopTotal desktop opens.
WebMailTotal webmail opens.
MobileTotal mobile opens.
UnknownTotal unknown opens.
OpenWebhookPayload
RecordTypeAlways Open.
MessageIDUnique ID of the message.
RecipientRecipient that opened the message.
FirstOpenWhether this is the first open of the message.
Email client (or browser) details detected from the user agent.
Operating system details detected from the user agent.
PlatformPlatform the email was opened or clicked on.
UserAgentFull user-agent header.
ReadSecondsSeconds the message was read for, when known.
Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.
MessageStreamMessage stream the message was sent through.
Tag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
ReceivedAtTime of the open.
OperatingSystem
NameOperating system name and version.
CompanyCompany that produced the operating system.
FamilyOperating system family.
OutboundMessageDetails
Tag of the message.
MessageIDUnique ID of the message.
MessageStreamMessage stream the message was sent through.
To recipients. Field of OutboundMessageDetails.
Cc recipients. Field of OutboundMessageDetails.
Bcc recipients.
RecipientsAll recipient email addresses.
ReceivedAtTime Postmark processed the message.
FromSender address. Field of OutboundMessageDetails.
SubjectSubject. Field of OutboundMessageDetails.
AttachmentsNames of attached files.
StatusMessage status in Postmark Activity.
TrackOpensWhether open tracking was enabled.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
SandboxedWhether the message was sent from a sandbox server.
TextBodyPlain-text body. Field of OutboundMessageDetails.
HtmlBodyHTML body. Field of OutboundMessageDetails.
BodyRaw message source. Field of OutboundMessageDetails.
Events for this message in the order they occurred.
OutboundMessageList
TotalCountNumber of messages matching the search. A message sent to several recipients counts once here.
Messages for the requested page. Field of OutboundMessageList.
OutboundMessageSummary
Tag of the message.
MessageIDUnique ID of the message.
MessageStreamMessage stream the message was sent through.
To recipients. Field of OutboundMessageSummary.
Cc recipients. Field of OutboundMessageSummary.
Bcc recipients. Field of OutboundMessageSummary.
RecipientsAll recipient email addresses. Field of OutboundMessageSummary.
ReceivedAtTime Postmark processed the message.
Sender address. Field of OutboundMessageDetails.
Subject. Field of OutboundMessageDetails.
AttachmentsNames of attached files. Field of OutboundMessageSummary.
StatusMessage status in Postmark Activity.
TrackOpensWhether open tracking was enabled.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
SandboxedWhether the message was sent from a sandbox server.
OutboundOverviewStats
SentTotal emails sent.
BouncedTotal bounces.
SMTPApiErrorsTotal SMTP API errors.
BounceRateBounce rate as a percentage.
SpamComplaintsTotal spam complaints.
SpamComplaintsRateSpam complaint rate as a percentage.
OpensTotal opens.
UniqueOpensUnique opens.
TrackedEmails sent with open tracking.
WithClientRecordedOpens with a recorded email client.
WithPlatformRecordedOpens with a recorded platform.
WithReadTimeRecordedOpens with a recorded read time.
TotalTrackedLinksSentEmails sent with link tracking.
UniqueLinksClickedUnique links clicked.
TotalClicksTotal clicks. Field of OutboundOverviewStats.
WithLinkTrackingEmails sent with link tracking enabled.
WithOpenTrackingEmails sent with open tracking enabled.
Platform
Platform the email was opened or clicked on.
PushTemplatesRequest
SourceServerIDID of the server to copy templates from.
DestinationServerIDID of the server to copy templates to.
PerformChangestrue applies the push; false only previews what would change.
PushTemplatesResponse
TotalCountNumber of templates affected.
Templates pushed or that would be pushed.
SendEmailBatchRequest
Up to 500 messages (and 50 MB total payload, attachments included) per call.
FromSender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
ToRecipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
CcCc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
BccBcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
SubjectEmail subject line. Max 2000 characters.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
HtmlBodyHTML body. Required if TextBody is not specified.
TextBodyPlain-text body. Required if HtmlBody is not specified.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: HtmlBody | |
| type = object · requires: TextBody |
HtmlBodyHTML body. Required if TextBody is not specified.
FromSender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
ToRecipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
CcCc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
BccBcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
SubjectEmail subject line. Max 2000 characters.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
TextBodyPlain-text body. Required if HtmlBody is not specified.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
SendEmailBatchResponse
One result per submitted message, in the same order as the request.
ErrorCode0 when the message was accepted; otherwise an API error code.
MessageOK on success, or a description of the error.
ToRecipient email address. Field of SendEmailResponse.
SubmittedAtTime the message was accepted by Postmark.
MessageIDUnique ID of the message. Use it to look up details, bounces, opens and clicks.
SendEmailBatchWithTemplatesRequest
Up to 500 templated messages.
SendEmailRequest
FromSender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
ToRecipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
CcCc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
BccBcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
SubjectEmail subject line. Max 2000 characters.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
HtmlBodyHTML body. Required if TextBody is not specified.
TextBodyPlain-text body. Required if HtmlBody is not specified.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: HtmlBody | |
| type = object · requires: TextBody |
HtmlBodyHTML body. Required if TextBody is not specified.
FromSender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
ToRecipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
CcCc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
BccBcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
SubjectEmail subject line. Max 2000 characters.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
TextBodyPlain-text body. Required if HtmlBody is not specified.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
SendEmailResponse
ErrorCode0 when the message was accepted; otherwise an API error code.
MessageOK on success, or a description of the error.
ToRecipient email address. Field of SendEmailResponse.
SubmittedAtTime the message was accepted by Postmark.
MessageIDUnique ID of the message. Use it to look up details, bounces, opens and clicks.
SendEmailWithTemplateRequest
Variables used to render the template, as a JSON object. Supports nested objects and arrays.
FromSender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
ToRecipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
TemplateIdID of the template to use. Provide either TemplateId or TemplateAlias.
TemplateAliasAlias of the template to use. Provide either TemplateAlias or TemplateId.
InlineCssApply <style> blocks as inline attributes in the rendered HTML. Defaults to true; pass false to opt out.
Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message. Field of SendEmailWithTemplateRequest.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB. Field of SendEmailWithTemplateRequest.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: TemplateId | |
| type = object · requires: TemplateAlias |
TemplateIdID of the template to use. Provide either TemplateId or TemplateAlias.
TemplateAliasAlias of the template to use. Provide either TemplateAlias or TemplateId.
Variables used to render the template, as a JSON object. Supports nested objects and arrays.
InlineCssApply <style> blocks as inline attributes in the rendered HTML. Defaults to true; pass false to opt out.
Sender email address. Must belong to a confirmed Sender Signature or verified domain. To include a name use "Full Name <sender@domain.com>". Max 255 characters.
Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.
Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.
TagTag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.
ReplyToReply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.
Custom headers to add to the message. Field of SendEmailWithTemplateRequest.
TrackOpensEnable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
Files to attach. Total message size may not exceed 10 MB. Field of SendEmailWithTemplateRequest.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
MessageStreamID of the message stream to send through. Defaults to the outbound transactional stream.
SenderSignature
IDUnique ID of the signature.
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignature.
ReplyToEmailAddressReply-To address. Field of SenderSignature.
From name.
ConfirmedWhether the signature has been confirmed.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
ConfirmationPersonalNotePersonal note shown to the confirmation email recipient.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
SenderSignatureList
TotalCountNumber of signatures on the account.
Signatures for the requested page.
SenderSignatureSummary
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignatureSummary.
ReplyToEmailAddressReply-To address. Field of SenderSignatureSummary.
NameFrom name. Field of SenderSignatureSummary.
ConfirmedWhether the signature has been confirmed. Field of SenderSignatureSummary.
Unique ID of the signature.
SentCountsStats
Per-day breakdown: sent counts per day.
SentTotal emails sent in the period.
Server
IDUnique ID of the server. Field of Server.
Server name.
ColorColor used to identify the server in the Postmark UI.
SmtpApiActivatedWhether sending through SMTP is enabled.
RawEmailEnabledWhether the raw email content is included in inbound webhooks.
InboundHookUrlWebhook URL for inbound messages.
BounceHookUrlWebhook URL for bounces (legacy; prefer the Webhooks API).
OpenHookUrlWebhook URL for opens (legacy; prefer the Webhooks API).
DeliveryHookUrlWebhook URL for deliveries (legacy; prefer the Webhooks API).
ClickHookUrlWebhook URL for clicks (legacy; prefer the Webhooks API).
PostFirstOpenOnlyOnly post the open webhook for the first open of a message.
InboundDomainYour own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.
InboundSpamThresholdSpam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).
TrackOpensTrack opens by default for messages sent from this server.
TrackLinksLink tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
IncludeBounceContentInHookInclude the bounce content in bounce webhooks.
EnableSmtpApiErrorHooksPost SMTP API errors to the bounce webhook URL.
ApiTokensServer API tokens (X-Postmark-Server-Token values).
ServerLinkURL of the server in the Postmark UI.
InboundAddressInbound email address of the server.
InboundHashHash used in the server's inbound address.
DeliveryTypeWhether the server delivers email (Live) or runs in sandbox mode (Sandbox).
ServerColor
Color used to identify the server in the Postmark UI.
ServerList
TotalCountNumber of servers matching the request.
Servers for the requested page.
SpamComplaintStats
Per-day breakdown: spam complaints per day.
SpamComplaintTotal complaints.
SpamComplaintWebhookPayload
RecordTypeAlways SpamComplaint.
MessageIDUnique ID of the message.
IDUnique ID of the bounce. Field of BounceWebhookPayload.
EmailAddress that bounced.
MessageStreamMessage stream the message was sent through.
Tag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
Bounce type.
TypeCodeNumeric bounce type code.
Bounce type display name.
DescriptionShort reason for the bounce.
DetailsDetailed reason from the receiving server.
Sender address.
BouncedAtBounce time.
DumpAvailableWhether the SMTP dump can be fetched.
InactiveWhether the address was deactivated.
CanActivateWhether the address can be reactivated.
SubjectSubject of the original message.
ServerIDID of the server. Field of BounceWebhookPayload.
ContentFull bounce content. Only present if IncludeContent is enabled.
StandardResponse
ErrorCodePostmark API error code. 0 means the request succeeded. See the API error code table in the API description.
MessageHuman-readable result of the request.
SubscriptionChangeWebhookPayload
RecordTypeAlways SubscriptionChange.
RecipientRecipient whose subscription changed.
SuppressSendingtrue when sending to the recipient is now suppressed.
MessageIDUnique ID of the message.
ServerIDID of the server. Field of BounceWebhookPayload.
MessageStreamMessage stream the message was sent through.
ChangedAtTime of the change.
OriginWho caused the suppression.
SuppressionReasonWhy the address is suppressed; null when sending is not suppressed.
Tag of the message.
Custom key/value metadata attached to a message. Keys and values are strings. Returned in webhook payloads and message details; you can search by a single metadata field at a time.
SubscriptionManagementConfiguration
UnsubscribeHandlingTypeHow unsubscribes are handled. None leaves it to you, Postmark adds Postmark-hosted unsubscribe handling, Custom lets you manage unsubscribes yourself.
SuppressionDump
Suppressed addresses on the stream.
SuppressionOrigin
Who caused the suppression.
SuppressionReason
Why the address is suppressed.
Template
TemplateIdUnique ID of the template.
Template name.
SubjectSubject template.
HtmlBodyHTML body template.
TextBodyPlain-text body template.
AssociatedServerIdID of the server the template belongs to.
ActiveWhether the template is active and can be used for sending.
Unique alias used to reference the template when sending.
TemplateTypeStandard templates render a full message; Layout templates wrap the content of Standard templates.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
TemplateList
TotalCountNumber of templates matching the request.
Templates for the requested page.
TemplateSummary
Whether the template is active.
TemplateIdUnique ID of the template.
Template name.
Unique alias used to reference the template when sending.
TemplateTypeStandard templates render a full message; Layout templates wrap the content of Standard templates.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
TemplateType
Standard templates render a full message; Layout templates wrap the content of Standard templates.
TemplateValidationResult
ContentIsValidWhether this part of the template parsed without errors.
Errors found.
RenderedContentRendered preview when a test model was supplied.
TrackLinks
Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.
TrackedCountsStats
Per-day breakdown: emails sent with open tracking per day.
TrackedTotal tracked emails.
ValidateTemplateRequest
SubjectSubject template to validate.
HtmlBodyHTML body template to validate.
TextBodyPlain-text body template to validate.
Model used to render a preview. If omitted, a suggested model is returned.
InlineCssForHtmlTestRenderInline CSS when rendering the HTML preview. Defaults to true.
TemplateTypeStandard templates render a full message; Layout templates wrap the content of Standard templates.
LayoutTemplateAlias of the Layout template that wraps this template, if any.
ValidateTemplateResponse
AllContentIsValidtrue only if every supplied part is valid.
Validation result for one part of the template.
Validation result for one part of the template.
Validation result for one part of the template.
A model with the variables the template appears to use.
Webhook
IDUnique ID of the webhook. Field of Webhook.
UrlURL Postmark posts events to.
MessageStreamMessage stream the webhook belongs to.
HTTP Basic Auth credentials Postmark sends with each webhook request.
Custom HTTP headers sent with each request.
Events a webhook receives. In edit requests, triggers you omit are left unchanged.
StatusVerification status. An unverified webhook receives no events until it passes verification.
WebhookHttpAuth
UsernameHTTP Basic Auth username.
PasswordHTTP Basic Auth password.
WebhookList
Webhooks on the server (or the filtered stream).
WebhookMetrics
TotalRequestsTotal webhook requests attempted.
SuccessCountRequests that succeeded.
FailureCountRequests that failed.
RetryCountRequests that were retried.
SuccessRatePercentage of successful requests.
SlowCountRequests that were slow to respond.
VerySlowCountRequests that were very slow to respond.
AverageTerminalResponseTimeMsAverage response time in ms for terminal attempts.
AverageRetryResponseTimeMsAverage response time in ms for retried attempts; null when there were no retries.
WebhookStatistics
WebhookIdID of the webhook.
ServerIdID of the server. Field of WebhookStatistics.
MessageStreamIdMessage stream the webhook belongs to.
UrlWebhook URL.
Verification status per trigger.
The window the statistics cover.
Delivery metrics for a webhook over the window.
The same metrics broken out per trigger (for example Bounce, Delivery).
WebhookTriggers
WebhookVerificationResult
IdID of the webhook that was tested.
UrlURL that was tested.
Successtrue only if every enabled event returned HTTP 200.
Per-event results.
MessageSummary of the verification.