Postmark
Postmark API

ActivateBounceResponse

Result of reactivating a bounced address.
Message
​string · required

Result of the reactivation attempt.

Example: OK
​Bounce · required

A bounce record.

ArchiveMessageStreamResponse

Result of archiving a stream.
ID
​string · required

ID of the archived stream.

Example: transactional-dev
ServerID
​integer · required

ID of the server.

Example: 123457
ExpectedPurgeDate
​string · date-time · required

Date the archived stream will be permanently deleted unless unarchived.

Example: 2026-11-05T09:30:00-04:00

Attachment

A file attached to an email. The total message size (body, headers and Base64-encoded attachments) may not exceed 10 MB.
Name
​string · required

File name shown to the recipient, including extension.

Example: report.pdf
Content
​string · required

Base64-encoded file content.

Example: dGVzdCBjb250ZW50
ContentType
​string · required

MIME type of the attachment.

Example: application/pdf
ContentID
​string | null

Content-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">).

Example: cid:logo.png

Bounce

A bounce record.
ID
​integer · int64

Unique ID of the bounce. Field of Bounce.

Example: 692560173
Type
​BounceType · enum

Type of bounce. See the Bounce types section of the Postmark docs for what each value means.

Enum values:
HardBounce
Transient
Unsubscribe
Subscribe
AutoResponder
AddressChange
DnsError
SpamNotification
Example: HardBounce
TypeCode
​integer

Numeric code of the bounce type.

Example: 1
Name
​string

Display name of the bounce type.

Example: Hard bounce
Tag
​string

Tag of the bounced message.

Example: Invitation
MessageID
​string · uuid

ID of the message that bounced.

Example: 2c1b63fe-43f2-4db5-91b0-8bdfa44a9316
ServerID
​integer

ID of the server that sent the message.

Example: 23
MessageStream
​string

Message stream the message was sent through.

Example: outbound
Description
​string

Short description of the bounce reason.

Example: The server was unable to deliver your message (ex: unknown user, mailbox not found).
Details
​string

Detailed reason reported by the receiving server.

Example: Test bounce details
Email
​string

Email address that bounced.

Example: isaac@example.com
From
​string

Sender address of the bounced message.

Example: sender@example.com
BouncedAt
​string · date-time

Time the bounce occurred.

Example: 2026-10-06T08:11:02.0000000-04:00
DumpAvailable
​boolean

Whether the raw SMTP dump is available (see Get bounce dump).

Example: true
Inactive
​boolean

Whether Postmark deactivated the address because of this bounce.

Example: true
CanActivate
​boolean

Whether the address can be reactivated.

Example: true
Subject
​string

Subject of the bounced message.

Example: Hello from our app
Content
​string

Raw content of the bounce. Only returned when fetching a single bounce.

Example: Return-Path: <> ...

BounceCountsStats

Bounce counts per day by type.
​object[]

Per-day breakdown: bounce counts per day by type.

Example: [{"Date":"2026-10-01","HardBounce":10,"SMTPApiError":2,"SoftBounce":1,"Transient":3}]
HardBounce
​integer

Total hard bounces.

Example: 100
SMTPApiError
​integer

Total SMTP API errors.

Example: 25
SoftBounce
​integer

Total soft bounces.

Example: 5
Transient
​integer

Total transient bounces.

Example: 20

BounceDump

Raw bounce source.
Body
​string · required

Raw SMTP source of the bounce. Empty string when no dump is available.

Example: Return-Path: <> Received: ...

BounceList

Paged list of bounces.
TotalCount
​integer · required

Number of bounces matching the search. May exceed the number returned in one call.

Example: 253
​Bounce[] · required

Bounces for the requested page.

Example: [{"ID":692560173,"Type":"HardBounce","TypeCode":1,"Name":"Hard bounce","Tag":"Invitation","MessageID":"2c1b63fe-43f2-4db5-91b0-8bdfa44a9316","ServerID":23,"MessageStream":"outbound","Description":"The server was unable to deliver your message (ex: unknown user, mailbox not found).","Details":"Test bounce details","Email":"isaac@example.com","From":"sender@example.com","BouncedAt":"2026-10-06T08:11:02.0000000-04:00","DumpAvailable":true,"Inactive":true,"CanActivate":true,"Subject":"Hello from our app","Content":"Return-Path: <>\n..."}]

BounceType

string · enum
Enum values:
HardBounce
Transient
Unsubscribe
Subscribe
AutoResponder
AddressChange
DnsError
SpamNotification

Type of bounce. See the Bounce types section of the Postmark docs for what each value means.

Example: HardBounce

BounceWebhookPayload

Payload posted to a webhook for a bounce event.
RecordType
​string · enum · required

Always Bounce.

Enum values:
Bounce
Example: Bounce
MessageID
​string · uuid · required

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
ID
​integer · int64 · required

Unique ID of the bounce. Field of BounceWebhookPayload.

Example: 4323372036854776000
Email
​string · required

Address that bounced.

Example: john@example.com
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
Tag
​string

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
Type
​string

Bounce type.

Example: HardBounce
TypeCode
​integer

Numeric bounce type code.

Example: 1
Name
​string

Bounce type display name.

Example: Hard bounce
Description
​string

Short reason for the bounce.

Example: The server was unable to deliver your message (ex: unknown user, mailbox not found).
Details
​string

Detailed reason from the receiving server.

Example: Test bounce details
From
​string

Sender address.

Example: sender@example.com
BouncedAt
​string · date-time

Bounce time.

Example: 2026-10-06T07:25:01Z
DumpAvailable
​boolean

Whether the SMTP dump can be fetched.

Example: true
Inactive
​boolean

Whether the address was deactivated.

Example: true

Whether the address can be reactivated.

Example: true
Subject
​string

Subject of the original message.

Example: Test subject
ServerID
​integer

ID of the server. Field of BounceWebhookPayload.

Example: 23
Content
​string

Full bounce content. Only present if IncludeContent is enabled.

Example: Return-Path: <>...

BrowserFamilyStats

Clicks per browser family, per day. Property names are browser families (e.g. `Chrome`, `Safari`).
​object[]

Per-day breakdown: clicks per browser family, per day.

Example: [{"Date":"2026-10-01","Gmail":1}]
integer

Total clicks for this browser family.

BulkEmailRequest

Bulk send request: define the content once and personalize with `TemplateModel` per recipient. Total payload may not exceed 50 MB.
From
​string · required

Sender email address. Must belong to a confirmed Sender Signature.

Example: sender@example.com
​BulkMessage[] · minItems: 1 · required

Recipients and their per-message data.

Example: [{"To":"receiver1@example.com","Cc":"cc@example.com","Bcc":"bcc@example.com","TemplateModel":{"FirstName":"Bob"},"Metadata":{"color":"blue","client-id":"12345"},"Headers":[{"Name":"X-Custom-Header","Value":"custom-value"}]}]
ReplyTo
​string

Reply-To override.

Example: replyto@example.com
Subject
​string

Email subject. May contain template variables.

Example: Newsletter for {{FirstName}}
HtmlBody
​string

HTML body. Required if no TextBody or template is given.

Example: <html><body>Hi, {{FirstName}}</body></html>
TextBody
​string

Plain-text body. Required if no HtmlBody or template is given.

Example: Hi, {{FirstName}}
TemplateId
​integer | null

ID of a hosted template. Alternative to submitting content inline.

TemplateAlias
​string | null

Alias of a hosted template. Alternative to submitting content inline.

InlineCss
​boolean

Inline <style> blocks of the template into the HTML. Defaults to true.

Example: true
Tag
​string · maxLength: 1000

Tag used to categorize messages. Max 1000 characters.

Example: Newsletter
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
MessageStream
​string

ID of the broadcast message stream. Defaults to the outbound broadcast stream.

Example: broadcast
TrackOpens
​boolean

Enable open tracking.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files attached to every message.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​CustomHeader[]

Custom headers applied to every message.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]

BulkMessage

One recipient of a bulk request, with per-recipient content.
To
​string · required

Recipient email addresses, comma separated. Max 50.

Example: receiver1@example.com
Cc
​string

Cc recipient email addresses, comma separated. Max 50.

Example: cc@example.com
Bcc
​string

Bcc recipient email addresses, comma separated. Max 50.

Example: bcc@example.com
​object

Recipient-specific template variables.

Example: {"FirstName":"Bob"}
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
​CustomHeader[]

Custom headers for this recipient. Take precedence over request-level headers.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]

BulkRequestList

Paged list of bulk request statuses.
​BulkRequestStatus[] · required

Bulk requests submitted on this server, newest first.

Example: [{"Id":"f24af63c-533d-4b7a-ad65-4a7b3202d3a7","SubmittedAt":"2026-10-06T07:25:01.4178645Z","Status":"Accepted","TotalMessages":500,"PercentageCompleted":0,"ReleasedCount":0,"FailedCount":0,"Subject":"October Newsletter"}]
PaginationKey
​string

Opaque cursor for the next page. Pass it back unchanged as paginationKey. Absent on the last page.

Example: eyJTdWJtaXR0ZWRBdCI6IjIwMjYtMDgtMTJUMDk6MDQ6MTdaIn0

BulkRequestStatus

Status of a Bulk API request. The same object is returned when submitting, fetching and listing bulk requests.
Id
​string · uuid · required

ID of the bulk request.

Example: f24af63c-533d-4b7a-ad65-4a7b3202d3a7
Status
​string · enum · required

Processing status of the request.

Enum values:
Accepted
Processing
Completed
Cancelled
Example: Accepted
SubmittedAt
​string · date-time · required

Time Postmark received the request.

Example: 2026-10-06T07:25:01.4178645Z
TotalMessages
​integer · required

Total number of messages in the request.

Example: 500
PercentageCompleted
​number · min: 0 · max: 100 · required

0-100 value showing how much of the request Postmark has finished. 100 means processing finished, not that every message was delivered.

Example: 0
ReleasedCount
​integer · required

Messages handed to the sending pipeline so far. Released is not the same as delivered.

Example: 0
FailedCount
​integer · required

Messages that will not be delivered or retried (for example suppressed recipients or template render failures).

Example: 0
Subject
​string

Email subject. Omitted when the request had none.

Example: October Newsletter

ClickCountsStats

Click counts per day.
​object[]

Per-day breakdown: click counts per day.

Example: [{"Date":"2026-10-01","TotalClicks":12,"Unique":8}]
TotalClicks
​integer

Total clicks.

Example: 90
Unique
​integer

Total unique clicks.

Example: 60

ClickEvent

A recorded click on a tracked link.
RecordType
​string

Type of record.

Example: Click
​Client

Email client (or browser) details detected from the user agent.

​OperatingSystem

Operating system details detected from the user agent.

Platform
​Platform · enum

Platform the email was opened or clicked on.

Enum values:
Desktop
WebMail
Mobile
Unknown
Example: WebMail
UserAgent
​string

Full user-agent header from the client.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36
​Geo

Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.

MessageID
​BounceWebhookPayload/properties/MessageID · uuid

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
ReceivedAt
​string · date-time

Time of the event.

Example: 2026-10-06T05:04:23.8768746-04:00

Tag of the message.

Example: welcome-user
Recipient
​string

Recipient email address.

Example: john.doe@example.com
OriginalLink
​string · uri

The tracked link that was clicked.

Example: https://example.com/features
ClickLocation
​string · enum

Where the link appeared in the message.

Enum values:
HTML
Text
Example: HTML

ClickList

Paged list of clicks.
TotalCount
​integer · required

Number of clicks matching the search.

Example: 1
​ClickEvent[] · required

Clicks for the requested page.

Example: [{"RecordType":"Click","Client":{"Name":"Chrome 119.0","Company":"Google Inc.","Family":"Chrome"},"OS":{"Name":"OS X 10.7 Lion","Company":"Apple Computer, Inc.","Family":"OS X"},"Platform":"WebMail","UserAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36","Geo":{"CountryISOCode":"RS","Country":"Serbia","RegionISOCode":"VO","Region":"Autonomna Pokrajina Vojvodina","City":"Novi Sad","Zip":"21000","Coords":"45.2517,19.8369","IP":"188.2.95.4"},"MessageID":"927e56d4-dc66-4070-bbf0-1db76c2ae14b","MessageStream":"outbound","ReceivedAt":"2026-10-06T05:04:23.8768746-04:00","Tag":"welcome-user","Recipient":"john.doe@example.com","OriginalLink":"https://example.com/features","ClickLocation":"HTML"}]

ClickLocationStats

Clicks per body location per day.
​object[]

Per-day breakdown: clicks per body location per day.

Example: [{"Date":"2026-10-01","HTML":10,"Text":2}]
HTML
​integer

Total HTML clicks.

Example: 80
Text
​integer

Total text clicks.

Example: 10

ClickPlatformStats

Clicks per platform per day.
​object[]

Per-day breakdown: clicks per platform per day.

Example: [{"Date":"2026-10-01","Desktop":8,"Mobile":6,"Unknown":1}]
Desktop
​integer

Total desktop clicks.

Example: 20
Mobile
​integer

Total mobile clicks.

Example: 30
Unknown
​integer

Total unknown clicks.

Example: 5

ClickWebhookPayload

Payload posted to a webhook for a click event.
RecordType
​string · enum · required

Always Click.

Enum values:
Click
Example: Click
OriginalLink
​ClickEvent/properties/OriginalLink · uri · required

The tracked link that was clicked.

Example: https://example.com/features
MessageID
​BounceWebhookPayload/properties/MessageID · uuid · required

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
Recipient
​string · required

Recipient that clicked.

Example: john@example.com
ClickLocation
​string · enum

Where the link appeared.

Enum values:
HTML
Text
Example: HTML
​Client

Email client (or browser) details detected from the user agent.

​OperatingSystem

Operating system details detected from the user agent.

Platform
​Platform · enum

Platform the email was opened or clicked on.

Enum values:
Desktop
WebMail
Mobile
Unknown
Example: WebMail
UserAgent
​string

Full user-agent header.

Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64)
​Geo

Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.

MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
ReceivedAt
​string · date-time

Time of the click.

Example: 2026-10-06T18:30:45Z

Client

Email client (or browser) details detected from the user agent.
Name
​string

Email client or browser name and version.

Example: Chrome 119.0
Company
​string

Company that produced the client.

Example: Google Inc.
Family
​string

Client family.

Example: Chrome

CreateDataRemovalRequest

GDPR data removal request details.
RequestedBy
​string · email · required

Email address of the person making the request.

Example: requester@example.com
RequestedFor
​string · email · required

Email address whose data should be removed.

Example: subject@example.com
NotifyWhenCompleted
​boolean

Email RequestedBy when the removal completes.

Example: true

CreateDomainRequest

Domain to add.
Name
​string · maxLength: 255 · required

Domain name to add.

Example: example.com
ReturnPathDomain
​string

Custom Return-Path subdomain of the domain, with a CNAME pointing to pm.mtasv.net.

Example: pm-bounces.example.com

CreateInboundRuleRequest

Rule to create. Field of `CreateInboundRuleRequest`.
Rule
​string · required

Email address or domain to block from inbound processing.

Example: someone@example.com

CreateMessageStreamRequest

Details of the stream to create.
ID
​string · maxLength: 30 · required

Unique stream ID. Starts with a letter, up to 30 characters, must not start with pm-.

Example: transactional-dev
Name
​string · required

Stream name.

Example: My Dev Transactional Stream
MessageStreamType
​MessageStreamType · enum · required

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
Description
​string

Stream description. No HTML.

Example: This is my second transactional stream
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.

CreateSenderSignatureRequest

Details of the signature to create.
FromEmail
​string · required

Email address of the signature.

Example: john.doe@example.com
Name
​string · required

From name.

Example: John Doe
ReplyToEmail
​string

Reply-To override address.

Example: reply@example.com
ReturnPathDomain
​string

Custom Return-Path subdomain with a CNAME to pm.mtasv.net.

Example: pm-bounces.example.com
ConfirmationPersonalNote
​string · maxLength: 400

Note shown in the confirmation email. Max 400 characters.

Example: This is a note visible to the recipient to provide context of what Postmark is.

CreateServerRequest

Settings for the new server. Field of `CreateServerRequest`.
Name
​string · required

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue
SmtpApiActivated
​boolean

Whether sending through SMTP is enabled.

Example: true
RawEmailEnabled
​boolean

Whether the raw email content is included in inbound webhooks.

Example: false
InboundHookUrl
​string

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound
BounceHookUrl
​string

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce
OpenHookUrl
​string

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open
DeliveryHookUrl
​string

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery
ClickHookUrl
​string

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click
PostFirstOpenOnly
​boolean

Only post the open webhook for the first open of a message.

Example: false
InboundDomain
​string

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​integer · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5
TrackOpens
​boolean

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
IncludeBounceContentInHook
​boolean

Include the bounce content in bounce webhooks.

Example: true
EnableSmtpApiErrorHooks
​boolean

Post SMTP API errors to the bounce webhook URL.

Example: false
DeliveryType
​string · enum

Live (default) delivers email; Sandbox captures email without delivering it. Cannot be changed after creation.

Enum values:
Live
Sandbox
Example: Live

CreateSuppressionsRequest

Addresses to suppress on the stream.
​object[] · minItems: 1 · maxItems: 50 · required

Addresses to process. Max 50 per request.

Example: [{"EmailAddress":"address@example.com"}]

CreateSuppressionsResponse

Per-address results of a suppression request.
​object[] · required

One result per submitted address.

Example: [{"EmailAddress":"good.address@example.com","Status":"Suppressed","Message":"string"}]

CreateTemplateRequest

Details of the template to create.
Name
​string · required

Template name.

Example: Onboarding Email
Subject
​string

Subject template. Required for Standard templates.

Example: Hello from {{company.name}}!
HtmlBody
​string

HTML body template. HtmlBody or TextBody is required.

Example: <html><body>Hello, {{name}}!</body></html>
TextBody
​string

Plain-text body template.

Example: Hello, {{name}}!
Alias
​string | null

Unique alias used to reference the template when sending.

Example: onboarding-v1
TemplateType
​TemplateType · enum

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Enum values:
Standard
Layout
Example: Standard
LayoutTemplate
​string | null

Alias of the Layout template that wraps this template, if any.

Example: my-layout

CreateTemplateResponse

The created template. Field of `CreateTemplateResponse`.
TemplateId
​integer

ID of the new template.

Example: 1234567

Template name.

Example: Onboarding Email
Active
​boolean

Whether the template is active.

Example: true

Unique alias used to reference the template when sending.

Example: onboarding-v1
TemplateType
​TemplateType · enum

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Enum values:
Standard
Layout
Example: Standard

Alias of the Layout template that wraps this template, if any.

Example: my-layout

CreateWebhookRequest

Webhook to create.
Url
​string · uri · required

URL Postmark posts events to.

Example: https://www.example.com/webhook-test-tracking
MessageStream
​string

Stream to attach the webhook to. Defaults to outbound. Cannot be an inbound or archived stream.

Example: outbound
​WebhookHttpAuth

HTTP Basic Auth credentials Postmark sends with each webhook request.

​CustomHeader[]

Custom HTTP headers to send with each request.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
​WebhookTriggers

Events a webhook receives. In edit requests, triggers you omit are left unchanged.

Verify
​boolean

Test the endpoint for each enabled event before saving. Defaults to true. Set false to save unverified; the webhook receives no events until verified.

Example: true

CustomHeader

A name/value pair used for custom email headers and webhook HTTP headers.
Name
​string · required

Header name.

Example: X-Custom-Header
Value
​string · required

Header value.

Example: custom-value

DataRemovalStatus

Status of a data removal request.
ID
​integer · required

Unique ID of the data removal request. Field of DataRemovalStatus.

Example: 1234
Status
​string · required

Current status of the request.

Example: Pending

DeleteSuppressionsRequest

Addresses to remove from the suppression list.
​object[] · minItems: 1 · maxItems: 50 · required

Addresses to process. Max 50 per request. Field of DeleteSuppressionsRequest.

Example: [{"EmailAddress":"address@example.com"}]

DeleteSuppressionsResponse

Per-address results of a suppression removal. Addresses suppressed by hard bounce or spam complaint can only be removed by Postmark-managed rules; those return `Failed`.
​object[] · required

One result per submitted address. Field of DeleteSuppressionsResponse.

Example: [{"EmailAddress":"good.address@example.com","Status":"Deleted","Message":"string"}]

DeliveryStats

Summary of bounces on a server.
InactiveMails
​integer · required

Number of addresses currently deactivated because of bounces.

Example: 192
​object[] · required

Bounce counts grouped by type. The entry named All is the total.

Example: [{"Type":"HardBounce","Name":"All","Count":253}]

DeliveryWebhookPayload

Payload posted to a webhook for a delivery event.
RecordType
​string · enum · required

Always Delivery.

Enum values:
Delivery
Example: Delivery
MessageID
​BounceWebhookPayload/properties/MessageID · uuid · required

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
Recipient
​string · required

Recipient the message was delivered to.

Example: john@example.com

ID of the server. Field of BounceWebhookPayload.

Example: 23
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
DeliveredAt
​string · date-time

Delivery time.

Example: 2026-10-06T07:25:01Z
Details
​string

Delivery details reported by the receiving server.

Example: Test delivery webhook details

Domain

A sending domain with its DNS verification details.
ID
​integer

Unique ID of the domain. Field of Domain.

Example: 36735
Name
​string

Domain name.

Example: example.com
SPFHost
​string

Host name for the optional SPF configuration.

Example: example.com
SPFTextValue
​string

Optional SPF TXT value.

Example: v=spf1 a mx include:spf.mtasv.net ~all
DKIMVerified
​boolean

Whether DKIM has ever been verified. Stays true even if the record is later removed from DNS.

Example: true
WeakDKIM
​boolean

true if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.

Example: false
DKIMHost
​string

DNS TXT host currently used to validate DKIM.

Example: 20260101000000pm._domainkey.example.com
DKIMTextValue
​string

DNS TXT value currently used to validate DKIM.

Example: k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...
DKIMPendingHost
​string

Pending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).

Example:
DKIMPendingTextValue
​string

Pending DKIM TXT value not yet confirmed in DNS.

Example:
DKIMRevokedHost
​string

Revoked DKIM TXT host that will be removed.

Example:
DKIMRevokedTextValue
​string

Revoked DKIM TXT value that will be removed.

Example:
SafeToRemoveRevokedKeyFromDNS
​boolean

true when the old DKIM records can be safely deleted from DNS.

Example: false
DKIMUpdateStatus
​string

Pending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.

Example: Verified
ReturnPathDomain
​string

Custom Return-Path domain.

Example: pm-bounces.example.com
ReturnPathDomainVerified
​boolean

Whether the Return-Path CNAME is verified and in use.

Example: true
ReturnPathDomainCNAMEValue
​string

CNAME value Postmark expects at the Return-Path domain.

Example: pm.mtasv.net

DomainList

Paged list of domains.
TotalCount
​integer · required

Number of domains on the account.

Example: 2
​DomainSummary[] · required

Domains for the requested page.

Example: [{"Name":"example.com","SPFVerified":true,"DKIMVerified":true,"WeakDKIM":false,"ReturnPathDomainVerified":true,"ID":36735}]

DomainSummary

Brief domain details as returned in lists.

Domain name.

Example: example.com
DKIMVerified
​Domain/properties/DKIMVerified

Whether DKIM has ever been verified. Stays true even if the record is later removed from DNS.

Example: true

true if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.

Example: false
ReturnPathDomainVerified
​Domain/properties/ReturnPathDomainVerified

Whether the Return-Path CNAME is verified and in use.

Example: true

Unique ID of the domain. Field of Domain.

Example: 36735

EditDomainRequest

Domain settings to change. Field of `EditDomainRequest`.
ReturnPathDomain
​string

New custom Return-Path subdomain.

Example: pm-bounces.example.com

EditMessageStreamRequest

Fields to change. Omitted fields are left unchanged.
Name
​string

New stream name.

Example: Updated Dev Stream
Description
​string

New stream description.

Example: Updating my dev transactional stream
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.

EditSenderSignatureRequest

Signature details to change. Field of `EditSenderSignatureRequest`.
Name
​string · required

From name. Field of EditSenderSignatureRequest.

Example: Jane Doe
ReplyToEmail
​string

Reply-To override address. Field of EditSenderSignatureRequest.

Example: jane.doe@example.com

Custom Return-Path subdomain with a CNAME to pm.mtasv.net.

Example: pm-bounces.example.com
ConfirmationPersonalNote
​string · maxLength: 400

Note shown in the confirmation email. Max 400 characters. Field of EditSenderSignatureRequest.

Example: Hi, this is Postmark.

EditServerRequest

Settings to change. Omitted fields are left unchanged.

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue

Whether sending through SMTP is enabled.

Example: true

Whether the raw email content is included in inbound webhooks.

Example: false

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click

Only post the open webhook for the first open of a message.

Example: false

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​CreateServerRequest/properties/InboundSpamThreshold · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText

Include the bounce content in bounce webhooks.

Example: true

Post SMTP API errors to the bounce webhook URL.

Example: false

EditTemplateRequest

Fields to change. Omitted fields are left unchanged. Field of `EditTemplateRequest`.

Template name.

Example: Onboarding Email
Subject
​string

Subject template.

Example: Hello from {{company.name}}!
HtmlBody
​string

HTML body template.

Example: <html><body>Hello, {{name}}!</body></html>

Plain-text body template.

Example: Hello, {{name}}!

Unique alias used to reference the template when sending.

Example: onboarding-v1

Alias of the Layout template that wraps this template, if any.

Example: my-layout

EditWebhookRequest

Webhook fields to change. Editing re-verifies the webhook unless `Verify` is `false`.
Url
​CreateWebhookRequest/properties/Url · uri

URL Postmark posts events to.

Example: https://www.example.com/webhook-test-tracking
​WebhookHttpAuth

HTTP Basic Auth credentials Postmark sends with each webhook request.

​CustomHeader[]

Custom HTTP headers to send with each request. Field of EditWebhookRequest.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
​WebhookTriggers

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.

Example: true

EmailAddress

An email address with an optional display name.
Email
​string · email

Email address. Field of EmailAddress.

Example: john.doe@example.com
Name
​string | null

Display name, if any.

Example: John Doe

EmailClientStats

Opens per email client, per day. Property names are client names (e.g. `Gmail`, `Outlook`).
​object[]

Per-day breakdown: opens per email client, per day.

Example: [{"Date":"2026-10-01","Gmail":1}]
integer

Total opens for this email client.

ErrorResponse

Error body returned for failed requests (HTTP 4xx and 5xx).
ErrorCode
​integer · required

Postmark API error code that identifies the type of error. Also echoed in the X-PM-ApiErrorCode response header.

Example: 403
Message
​string · required

Human-readable description of the error.

Example: Invalid request field(s): 'From'.
​object

Present when several validation errors occurred (ErrorCode 11, Bulk API). Keys are request field names; values are the errors found for that field.

Example: {"key":[{"ErrorCode":300,"Message":"Invalid 'To' address: 'test'."}]}

Geo

Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.
CountryISOCode
​string

ISO 3166-1 alpha-2 country code.

Example: RS
Country
​string

Country name.

Example: Serbia
RegionISOCode
​string

Region ISO code.

Example: VO
Region
​string

Region name.

Example: Autonomna Pokrajina Vojvodina
City
​string

City name.

Example: Novi Sad
Zip
​string

Postal code.

Example: 21000
Coords
​string

Latitude and longitude, comma separated.

Example: 45.2517,19.8369
IP
​string

IP address the event came from.

Example: 188.2.95.4

InboundAddress

An address on an inbound message.
Email
​string

Email address. Field of InboundAddress.

Example: dart-zzzzz@example.com
Name
​string

Display name.

Example: Dart Zzzzz
MailboxHash
​string

Mailbox hash part of the address, if any.

Example:

InboundAttachment

Attachment metadata of an inbound message.
Name
​string

File name.

Example: myimage.png
ContentID
​string

Content-ID, empty when not inline.

Example: myimage.png@01CE7342.75E71F80
ContentType
​string

MIME type.

Example: image/png
ContentLength
​integer

Size in bytes.

Example: 4096

InboundMessageDetails

Full details of an inbound message.
From
​string

Sender email address.

Example: dart-zzzzz@example.com
FromName
​string

Sender name.

Example: Dart Zzzzz
​InboundAddress

An address on an inbound message.

To
​string

To recipients as a string.

Example: ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com
​InboundAddress[]

To recipients.

Example: [{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}]
Cc
​string

Cc recipients as a string.

Example:
​InboundAddress[]

Cc recipients.

Example: [{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}]
ReplyTo
​string

Reply-To address.

Example:
OriginalRecipient
​string

Receiver (RCPT TO) address.

Example: ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com
Subject
​string

Subject.

Example: Test
Date
​string

Date header of the message.

Example: Thu, 13 Feb 2014 17:48:22 +0300
MailboxHash
​string

Custom hash the email was sent to.

Example:
Tag
​string

Tag.

Example:
​InboundAttachment[]

Attachments.

Example: [{"Name":"myimage.png","ContentID":"myimage.png@01CE7342.75E71F80","ContentType":"image/png","ContentLength":4096}]
MessageID
​string · uuid

Unique ID of the message. Field of InboundMessageDetails.

Example: cc5727a0-ea30-4e79-baea-aa43c9628ac4
Status
​string · enum

Message status.

Enum values:
Blocked
Processed
Queued
Failed
Scheduled
Example: Processed
TextBody
​string

Plain-text body.

Example: stuff stuff.
HtmlBody
​string

HTML body.

Example:
​CustomHeader[]

All message headers.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
BlockedReason
​string

Reason the message was blocked, when applicable.

Example: Inbound request blocked by domain rule: badsender@example.com

InboundMessageList

Paged list of inbound messages.
TotalCount
​integer · required

Number of messages matching the search.

Example: 7
​InboundMessageSummary[] · required

Messages for the requested page.

Example: [{"From":"dart-zzzzz@example.com","FromName":"Dart Zzzzz","FromFull":{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""},"To":"ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com","ToFull":[{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}],"Cc":"","CcFull":[{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}],"ReplyTo":"","OriginalRecipient":"ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com","Subject":"Test","Date":"Thu, 13 Feb 2014 17:48:22 +0300","MailboxHash":"","Tag":"","Attachments":[{"Name":"myimage.png","ContentID":"myimage.png@01CE7342.75E71F80","ContentType":"image/png","ContentLength":4096}],"MessageID":"cc5727a0-ea30-4e79-baea-aa43c9628ac4","Status":"Processed"}]

InboundMessageSummary

Summary of an inbound message.

Sender email address.

Example: dart-zzzzz@example.com

Sender name.

Example: Dart Zzzzz
​InboundAddress

An address on an inbound message.

To recipients as a string.

Example: ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com
​InboundAddress[]

To recipients. Field of InboundMessageSummary.

Example: [{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}]

Cc recipients as a string.

Example:
​InboundAddress[]

Cc recipients. Field of InboundMessageSummary.

Example: [{"Email":"dart-zzzzz@example.com","Name":"Dart Zzzzz","MailboxHash":""}]

Reply-To address.

Example:

Receiver (RCPT TO) address.

Example: ad8a4d0842c486355a33a7f019caab51@inbound.postmarkapp.com

Subject.

Example: Test

Date header of the message.

Example: Thu, 13 Feb 2014 17:48:22 +0300

Custom hash the email was sent to.

Example:

Tag.

Example:
​InboundAttachment[]

Attachments. Field of InboundMessageSummary.

Example: [{"Name":"myimage.png","ContentID":"myimage.png@01CE7342.75E71F80","ContentType":"image/png","ContentLength":4096}]
MessageID
​InboundMessageDetails/properties/MessageID · uuid

Unique ID of the message. Field of InboundMessageDetails.

Example: cc5727a0-ea30-4e79-baea-aa43c9628ac4
Status
​InboundMessageDetails/properties/Status · enum

Message status.

Enum values:
Blocked
Processed
Queued
Failed
Scheduled
Example: Processed

InboundRule

An inbound blocking rule.
ID
​integer

Unique ID of the rule.

Example: 1234567
Rule
​string

Email address or domain that is blocked.

Example: someone@example.com

InboundRuleList

Paged list of inbound rules.
TotalCount
​integer · required

Number of rules on the server.

Example: 2
​InboundRule[] · required

Rules for the requested page.

Example: [{"ID":1234567,"Rule":"someone@example.com"}]

MessageDump

Raw message source.
Body
​string · required

Raw source of the message. Empty string when no dump is available.

Example: From: "John Doe" <john.doe@example.com> Subject: Parts Order #5454 Thank you for your order

MessageEvent

Something that happened to a message after it was sent.
Recipient
​string

Recipient the event relates to.

Example: john.doe@example.com
Type
​string · enum

Event type.

Enum values:
Delivered
Transient
Bounced
Opened
LinkClicked
SubscriptionChanged
Example: Delivered
ReceivedAt
​string · date-time

Time of the event. Field of MessageEvent.

Example: 2026-10-06T07:26:10.8054242-04:00
​object

Event-specific details, such as DeliveryMessage, DestinationServer, DestinationIP, Summary, BounceID, Link, ClickLocation, Origin or SuppressSending.

Example: {"DeliveryMessage":"smtp;250 2.0.0 OK","DestinationServer":"mx.example.com","DestinationIP":"203.0.113.5"}

MessageStream

A message stream.
ID
​string

Unique ID of the stream, used as MessageStream when sending.

Example: transactional-dev
ServerID
​integer

ID of the server the stream belongs to.

Example: 123457

Stream name.

Example: My Dev Transactional Stream
Description
​string

Stream description.

Example: This is my second transactional stream
MessageStreamType
​MessageStreamType · enum

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Enum values:
Transactional
Inbound
Broadcast
Example: Transactional
CreatedAt
​string · date-time

Creation time.

Example: 2026-10-06T08:00:00-04:00
UpdatedAt
​string | null · date-time

Last update time.

Example: 2026-10-06T09:00:00-04:00
ArchivedAt
​string | null · date-time

Time the stream was archived, if archived.

Example: 2026-10-06T09:30:00-04:00
ExpectedPurgeDate
​string | null · date-time

Date an archived stream will be permanently deleted.

Example: 2026-11-05T09:30:00-04:00
​SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.

MessageStreamList

A list of message streams.
TotalCount
​integer · required

Number of streams matching the request.

Example: 2
​MessageStream[] · required

Streams on the server.

Example: [{"ID":"transactional-dev","ServerID":123457,"Name":"My Dev Transactional Stream","Description":"This is my second transactional stream","MessageStreamType":"Transactional","CreatedAt":"2026-10-06T08:00:00-04:00","UpdatedAt":"2026-10-06T09:00:00-04:00","ArchivedAt":"2026-10-06T09:30:00-04:00","ExpectedPurgeDate":"2026-11-05T09:30:00-04:00","SubscriptionManagementConfiguration":{"UnsubscribeHandlingType":"None"}}]

MessageStreamType

string · enum
Enum values:
Transactional
Inbound
Broadcast

Transactional for one-to-one triggered email, Broadcast for bulk/marketing email, Inbound for inbound processing.

Example: Transactional

Metadata

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.
string

OpenCountsStats

Open counts per day.
​object[]

Per-day breakdown: open counts per day.

Example: [{"Date":"2026-10-01","Opens":44,"Unique":17}]
Opens
​integer

Total opens.

Example: 166
Unique
​integer

Total unique opens.

Example: 26

OpenEvent

A recorded open of a message. Client, OS, Platform and Geo may be missing if Postmark could not determine them.
RecordType
​string

Type of record. Field of OpenEvent.

Example: Open
​Client

Email client (or browser) details detected from the user agent.

​OperatingSystem

Operating system details detected from the user agent.

Platform
​Platform · enum

Platform the email was opened or clicked on.

Enum values:
Desktop
WebMail
Mobile
Unknown
Example: WebMail

Full user-agent header from the client.

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36
​Geo

Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.

MessageID
​BounceWebhookPayload/properties/MessageID · uuid

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
ReceivedAt
​ClickEvent/properties/ReceivedAt · date-time

Time of the event.

Example: 2026-10-06T05:04:23.8768746-04:00

Tag of the message.

Example: welcome-user

Recipient email address.

Example: john.doe@example.com

OpenList

Paged list of opens.
TotalCount
​integer · required

Number of opens matching the search.

Example: 1
​OpenEvent[] · required

Opens for the requested page.

Example: [{"RecordType":"Open","Client":{"Name":"Chrome 119.0","Company":"Google Inc.","Family":"Chrome"},"OS":{"Name":"OS X 10.7 Lion","Company":"Apple Computer, Inc.","Family":"OS X"},"Platform":"WebMail","UserAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.36","Geo":{"CountryISOCode":"RS","Country":"Serbia","RegionISOCode":"VO","Region":"Autonomna Pokrajina Vojvodina","City":"Novi Sad","Zip":"21000","Coords":"45.2517,19.8369","IP":"188.2.95.4"},"MessageID":"927e56d4-dc66-4070-bbf0-1db76c2ae14b","MessageStream":"outbound","ReceivedAt":"2026-10-06T05:04:23.8768746-04:00","Tag":"welcome-user","Recipient":"john.doe@example.com"}]

OpenPlatformStats

Opens per platform per day.
​object[]

Per-day breakdown: opens per platform per day.

Example: [{"Date":"2026-10-01","Desktop":8,"WebMail":12,"Mobile":6,"Unknown":1}]
Desktop
​integer

Total desktop opens.

Example: 20
WebMail
​integer

Total webmail opens.

Example: 40
Mobile
​integer

Total mobile opens.

Example: 30
Unknown
​integer

Total unknown opens.

Example: 5

OpenWebhookPayload

Payload posted to a webhook for an open event.
RecordType
​string · enum · required

Always Open.

Enum values:
Open
Example: Open
MessageID
​BounceWebhookPayload/properties/MessageID · uuid · required

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
Recipient
​string · required

Recipient that opened the message.

Example: john@example.com
FirstOpen
​boolean

Whether this is the first open of the message.

Example: true
​Client

Email client (or browser) details detected from the user agent.

​OperatingSystem

Operating system details detected from the user agent.

Platform
​Platform · enum

Platform the email was opened or clicked on.

Enum values:
Desktop
WebMail
Mobile
Unknown
Example: WebMail

Full user-agent header.

Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64)
ReadSeconds
​integer

Seconds the message was read for, when known.

Example: 5
​Geo

Geolocation derived from the recipient's IP address. Any field may be missing when Postmark could not determine it.

MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
ReceivedAt
​string · date-time

Time of the open.

Example: 2026-10-06T18:24:47Z

OperatingSystem

Operating system details detected from the user agent.
Name
​string

Operating system name and version.

Example: OS X 10.7 Lion
Company
​string

Company that produced the operating system.

Example: Apple Computer, Inc.
Family
​string

Operating system family.

Example: OS X

OutboundMessageDetails

Full details of an outbound message, including bodies and events.

Tag of the message.

Example: welcome-user
MessageID
​BounceWebhookPayload/properties/MessageID · uuid

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
​EmailAddress[]

To recipients. Field of OutboundMessageDetails.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
​EmailAddress[]

Cc recipients. Field of OutboundMessageDetails.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
​EmailAddress[]

Bcc recipients.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
Recipients
​string[]

All recipient email addresses.

Example: ["john.doe@example.com"]
ReceivedAt
​string · date-time

Time Postmark processed the message.

Example: 2026-10-06T07:25:02.8782715-04:00
From
​string

Sender address. Field of OutboundMessageDetails.

Example: "Joe" <joe@example.com>
Subject
​string

Subject. Field of OutboundMessageDetails.

Example: Welcome aboard
Attachments
​string[]

Names of attached files.

Example: ["report.pdf"]
Status
​string · enum

Message status in Postmark Activity.

Enum values:
Queued
Sent
Processed
Example: Sent
TrackOpens
​boolean

Whether open tracking was enabled.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
Sandboxed
​boolean

Whether the message was sent from a sandbox server.

Example: false
TextBody
​string

Plain-text body. Field of OutboundMessageDetails.

Example: Thank you for your order...
HtmlBody
​string

HTML body. Field of OutboundMessageDetails.

Example: <p>Thank you for your order...</p>
Body
​string

Raw message source. Field of OutboundMessageDetails.

Example: SMTP dump data
​MessageEvent[]

Events for this message in the order they occurred.

Example: [{"Recipient":"john.doe@example.com","Type":"Delivered","ReceivedAt":"2026-10-06T07:26:10.8054242-04:00","Details":{"DeliveryMessage":"smtp;250 2.0.0 OK","DestinationServer":"mx.example.com","DestinationIP":"203.0.113.5"}}]

OutboundMessageList

Paged list of outbound messages.
TotalCount
​integer · required

Number of messages matching the search. A message sent to several recipients counts once here.

Example: 194
​OutboundMessageSummary[] · required

Messages for the requested page. Field of OutboundMessageList.

Example: [{"Tag":"welcome-user","MessageID":"927e56d4-dc66-4070-bbf0-1db76c2ae14b","MessageStream":"outbound","To":[{"Email":"john.doe@example.com","Name":"John Doe"}],"Cc":[{"Email":"john.doe@example.com","Name":"John Doe"}],"Bcc":[{"Email":"john.doe@example.com","Name":"John Doe"}],"Recipients":["john.doe@example.com"],"ReceivedAt":"2026-10-06T07:25:02.8782715-04:00","From":"\"Joe\" <joe@example.com>","Subject":"Welcome aboard","Attachments":["report.pdf"],"Status":"Sent","TrackOpens":true,"TrackLinks":"HtmlAndText","Metadata":{"color":"blue","client-id":"12345"},"Sandboxed":false}]

OutboundMessageSummary

Summary of an outbound message.

Tag of the message.

Example: welcome-user
MessageID
​BounceWebhookPayload/properties/MessageID · uuid

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
​EmailAddress[]

To recipients. Field of OutboundMessageSummary.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
​EmailAddress[]

Cc recipients. Field of OutboundMessageSummary.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
​EmailAddress[]

Bcc recipients. Field of OutboundMessageSummary.

Example: [{"Email":"john.doe@example.com","Name":"John Doe"}]
Recipients
​string[]

All recipient email addresses. Field of OutboundMessageSummary.

Example: ["john.doe@example.com"]
ReceivedAt
​OutboundMessageDetails/properties/ReceivedAt · date-time

Time Postmark processed the message.

Example: 2026-10-06T07:25:02.8782715-04:00

Sender address. Field of OutboundMessageDetails.

Example: "Joe" <joe@example.com>

Subject. Field of OutboundMessageDetails.

Example: Welcome aboard
Attachments
​string[]

Names of attached files. Field of OutboundMessageSummary.

Example: ["report.pdf"]
Status
​OutboundMessageDetails/properties/Status · enum

Message status in Postmark Activity.

Enum values:
Queued
Sent
Processed
Example: Sent

Whether open tracking was enabled.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}

Whether the message was sent from a sandbox server.

Example: false

OutboundOverviewStats

Aggregate outbound statistics for the requested period.
Sent
​integer

Total emails sent.

Example: 615
Bounced
​integer

Total bounces.

Example: 64

Total SMTP API errors.

Example: 25
BounceRate
​number

Bounce rate as a percentage.

Example: 10.406
SpamComplaints
​integer

Total spam complaints.

Example: 10
SpamComplaintsRate
​number

Spam complaint rate as a percentage.

Example: 1.626

Total opens.

Example: 166
UniqueOpens
​integer

Unique opens.

Example: 26
Tracked
​integer

Emails sent with open tracking.

Example: 111
WithClientRecorded
​integer

Opens with a recorded email client.

Example: 14
WithPlatformRecorded
​integer

Opens with a recorded platform.

Example: 10
WithReadTimeRecorded
​integer

Opens with a recorded read time.

Example: 0
TotalTrackedLinksSent
​integer

Emails sent with link tracking.

Example: 15
UniqueLinksClicked
​integer

Unique links clicked.

Example: 0
TotalClicks
​integer

Total clicks. Field of OutboundOverviewStats.

Example: 0
WithLinkTracking
​integer

Emails sent with link tracking enabled.

Example: 15
WithOpenTracking
​integer

Emails sent with open tracking enabled.

Example: 111

Platform

string · enum
Enum values:
Desktop
WebMail
Mobile
Unknown

Platform the email was opened or clicked on.

Example: WebMail

PushTemplatesRequest

Push all templates with aliases from one server to another.
SourceServerID
​integer · required

ID of the server to copy templates from.

Example: 997287
DestinationServerID
​integer · required

ID of the server to copy templates to.

Example: 997285
PerformChanges
​boolean · required

true applies the push; false only previews what would change.

Example: true

PushTemplatesResponse

Result of a template push.
TotalCount
​integer · required

Number of templates affected.

Example: 2
​object[] · required

Templates pushed or that would be pushed.

Example: [{"Action":"Create","TemplateId":1234567,"Alias":"onboarding-v1","Name":"Onboarding Email","TemplateType":"Standard"}]

SendEmailBatchRequest

​SendEmailRequest[] · minItems: 1 · maxItems: 500

Up to 500 messages (and 50 MB total payload, attachments included) per call.

A single email message. Provide at least one of `HtmlBody` or `TextBody`.
From
​string · required

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.

Example: Jane Sender <sender@example.com>
To
​string · required

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com
Cc
​string

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com
Bcc
​string

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Subject
​string · maxLength: 2000

Email subject line. Max 2000 characters.

Example: Password reset
Tag
​string · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset
HtmlBody
​string

HTML body. Required if TextBody is not specified.

Example: <html><body><b>Hello</b> <img src="cid:logo.png"/></body></html>
TextBody
​string

Plain-text body. Required if HtmlBody is not specified.

Example: Hello
ReplyTo
​string

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
TrackOpens
​boolean

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
MessageStream
​string

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: HtmlBody
type = object · requires: TextBody
Properties for Variant 1:
HtmlBody
​string · required

HTML body. Required if TextBody is not specified.

Example: <html><body><b>Hello</b> <img src="cid:logo.png"/></body></html>
From
​string

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.

Example: Jane Sender <sender@example.com>
To
​string

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com
Cc
​string

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com
Bcc
​string

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Subject
​string · maxLength: 2000

Email subject line. Max 2000 characters.

Example: Password reset
Tag
​string · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset
TextBody
​string

Plain-text body. Required if HtmlBody is not specified.

Example: Hello
ReplyTo
​string

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
TrackOpens
​boolean

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
MessageStream
​string

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound

SendEmailBatchResponse

One result per submitted message, in the same order as the request.

Result of sending one message. In batch responses, check `ErrorCode` on every entry because the HTTP status is 200 even when individual messages fail.
ErrorCode
​integer · required

0 when the message was accepted; otherwise an API error code.

Example: 0
Message
​string · required

OK on success, or a description of the error.

Example: OK
To
​string

Recipient email address. Field of SendEmailResponse.

Example: receiver@example.com
SubmittedAt
​string · date-time

Time the message was accepted by Postmark.

Example: 2026-10-06T09:15:30.1234567-04:00
MessageID
​string · uuid

Unique ID of the message. Use it to look up details, bounces, opens and clicks.

Example: 0a129aee-e1cd-480d-b08d-4f48548ff48d

SendEmailBatchWithTemplatesRequest

Batch of templated emails (max 500 messages and 50 MB per call).
​SendEmailWithTemplateRequest[] · minItems: 1 · maxItems: 500 · required

Up to 500 templated messages.

Example: [{"From":"sender@example.com","To":"receiver@example.com","TemplateAlias":"welcome-email","TemplateModel":{"name":"John Smith","product_name":"Postmark"},"MessageStream":"outbound"}]

SendEmailRequest

A single email message. Provide at least one of `HtmlBody` or `TextBody`.
From
​string · required

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.

Example: Jane Sender <sender@example.com>
To
​string · required

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com
Cc
​string

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com
Bcc
​string

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Subject
​string · maxLength: 2000

Email subject line. Max 2000 characters.

Example: Password reset
Tag
​string · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset
HtmlBody
​string

HTML body. Required if TextBody is not specified.

Example: <html><body><b>Hello</b> <img src="cid:logo.png"/></body></html>
TextBody
​string

Plain-text body. Required if HtmlBody is not specified.

Example: Hello
ReplyTo
​string

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
TrackOpens
​boolean

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
MessageStream
​string

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: HtmlBody
type = object · requires: TextBody
Properties for Variant 1:
HtmlBody
​string · required

HTML body. Required if TextBody is not specified.

Example: <html><body><b>Hello</b> <img src="cid:logo.png"/></body></html>
From
​string

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.

Example: Jane Sender <sender@example.com>
To
​string

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com
Cc
​string

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com
Bcc
​string

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Subject
​string · maxLength: 2000

Email subject line. Max 2000 characters.

Example: Password reset
Tag
​string · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset
TextBody
​string

Plain-text body. Required if HtmlBody is not specified.

Example: Hello
ReplyTo
​string

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
TrackOpens
​boolean

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}
MessageStream
​string

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound

SendEmailResponse

Result of sending one message. In batch responses, check `ErrorCode` on every entry because the HTTP status is 200 even when individual messages fail.
ErrorCode
​integer · required

0 when the message was accepted; otherwise an API error code.

Example: 0
Message
​string · required

OK on success, or a description of the error.

Example: OK
To
​string

Recipient email address. Field of SendEmailResponse.

Example: receiver@example.com
SubmittedAt
​string · date-time

Time the message was accepted by Postmark.

Example: 2026-10-06T09:15:30.1234567-04:00
MessageID
​string · uuid

Unique ID of the message. Use it to look up details, bounces, opens and clicks.

Example: 0a129aee-e1cd-480d-b08d-4f48548ff48d

SendEmailWithTemplateRequest

An email rendered from a Postmark template. Provide either `TemplateId` or `TemplateAlias`.
​object · required

Variables used to render the template, as a JSON object. Supports nested objects and arrays.

Example: {"name":"John Smith","product_name":"Postmark","company":{"name":"ACME"}}
From
​SendEmailRequest/properties/From · required

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.

Example: Jane Sender <sender@example.com>
To
​SendEmailRequest/properties/To · required

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com
TemplateId
​integer

ID of the template to use. Provide either TemplateId or TemplateAlias.

Example: 1234567
TemplateAlias
​string

Alias of the template to use. Provide either TemplateAlias or TemplateId.

Example: welcome-email
InlineCss
​boolean

Apply <style> blocks as inline attributes in the rendered HTML. Defaults to true; pass false to opt out.

Example: true

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Tag
​SendEmailRequest/properties/Tag · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message. Field of SendEmailWithTemplateRequest.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB. Field of SendEmailWithTemplateRequest.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: TemplateId
type = object · requires: TemplateAlias
Properties for Variant 1:
TemplateId
​integer · required

ID of the template to use. Provide either TemplateId or TemplateAlias.

Example: 1234567
TemplateAlias
​string

Alias of the template to use. Provide either TemplateAlias or TemplateId.

Example: welcome-email
​object

Variables used to render the template, as a JSON object. Supports nested objects and arrays.

Example: {"name":"John Smith","product_name":"Postmark","company":{"name":"ACME"}}
InlineCss
​boolean

Apply <style> blocks as inline attributes in the rendered HTML. Defaults to true; pass false to opt out.

Example: true

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.

Example: Jane Sender <sender@example.com>

Recipient email addresses, comma separated. Max 50 recipients across To, Cc and Bcc combined.

Example: receiver@example.com

Cc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: copied@example.com

Bcc recipient email addresses, comma separated. Counts toward the 50-recipient limit.

Example: blind-copied@example.com
Tag
​SendEmailRequest/properties/Tag · maxLength: 1000

Tag used to categorize outgoing emails and filter statistics. One tag per message, max 1000 characters.

Example: password-reset

Reply-To override. Defaults to the Reply-To of the Sender Signature. Multiple addresses are comma separated.

Example: reply@example.com
​CustomHeader[]

Custom headers to add to the message. Field of SendEmailWithTemplateRequest.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]

Enable open tracking for this message. Has no effect if open tracking is already enabled on the message stream.

Example: true
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText
​Attachment[]

Files to attach. Total message size may not exceed 10 MB. Field of SendEmailWithTemplateRequest.

Example: [{"Name":"report.pdf","Content":"dGVzdCBjb250ZW50","ContentType":"application/pdf","ContentID":"cid:logo.png"}]
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}

ID of the message stream to send through. Defaults to the outbound transactional stream.

Example: outbound

SenderSignature

A sender signature with DNS verification details.
ID
​integer

Unique ID of the signature.

Example: 36735
Domain
​string

Domain of the signature.

Example: example.com
EmailAddress
​string · email

Sender email address. Field of SenderSignature.

Example: john.doe@example.com
ReplyToEmailAddress
​string

Reply-To address. Field of SenderSignature.

Example: reply@example.com

From name.

Example: John Doe
Confirmed
​boolean

Whether the signature has been confirmed.

Example: false

Host name for the optional SPF configuration.

Example: example.com
SPFTextValue
​Domain/properties/SPFTextValue

Optional SPF TXT value.

Example: v=spf1 a mx include:spf.mtasv.net ~all
DKIMVerified
​Domain/properties/DKIMVerified

Whether DKIM has ever been verified. Stays true even if the record is later removed from DNS.

Example: true

true if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.

Example: false

DNS TXT host currently used to validate DKIM.

Example: 20260101000000pm._domainkey.example.com
DKIMTextValue
​Domain/properties/DKIMTextValue

DNS TXT value currently used to validate DKIM.

Example: k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...
DKIMPendingHost
​Domain/properties/DKIMPendingHost

Pending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).

Example:
DKIMPendingTextValue
​Domain/properties/DKIMPendingTextValue

Pending DKIM TXT value not yet confirmed in DNS.

Example:
DKIMRevokedHost
​Domain/properties/DKIMRevokedHost

Revoked DKIM TXT host that will be removed.

Example:
DKIMRevokedTextValue
​Domain/properties/DKIMRevokedTextValue

Revoked DKIM TXT value that will be removed.

Example:
SafeToRemoveRevokedKeyFromDNS
​Domain/properties/SafeToRemoveRevokedKeyFromDNS

true when the old DKIM records can be safely deleted from DNS.

Example: false
DKIMUpdateStatus
​Domain/properties/DKIMUpdateStatus

Pending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.

Example: Verified
ReturnPathDomain
​Domain/properties/ReturnPathDomain

Custom Return-Path domain.

Example: pm-bounces.example.com
ReturnPathDomainVerified
​Domain/properties/ReturnPathDomainVerified

Whether the Return-Path CNAME is verified and in use.

Example: true
ReturnPathDomainCNAMEValue
​Domain/properties/ReturnPathDomainCNAMEValue

CNAME value Postmark expects at the Return-Path domain.

Example: pm.mtasv.net
ConfirmationPersonalNote
​string

Personal note shown to the confirmation email recipient.

Example: This is a note visible to the recipient to provide context of what Postmark is.

SenderSignatureList

Paged list of sender signatures.
TotalCount
​integer · required

Number of signatures on the account.

Example: 2
​SenderSignatureSummary[] · required

Signatures for the requested page.

Example: [{"Domain":"example.com","EmailAddress":"jp@example.com","ReplyToEmailAddress":"info@example.com","Name":"JP Toto","Confirmed":true,"ID":36735}]

SenderSignatureSummary

Brief sender signature details as returned in lists.

Domain of the signature.

Example: example.com
EmailAddress
​string

Sender email address. Field of SenderSignatureSummary.

Example: jp@example.com
ReplyToEmailAddress
​string

Reply-To address. Field of SenderSignatureSummary.

Example: info@example.com
Name
​string

From name. Field of SenderSignatureSummary.

Example: JP Toto
Confirmed
​boolean

Whether the signature has been confirmed. Field of SenderSignatureSummary.

Example: true

Unique ID of the signature.

Example: 36735

SentCountsStats

Sent counts per day.
​object[]

Per-day breakdown: sent counts per day.

Example: [{"Date":"2026-10-01","Sent":140}]
Sent
​integer

Total emails sent in the period.

Example: 615

Server

A Postmark server.
ID
​integer

Unique ID of the server. Field of Server.

Example: 12345

Server name.

Example: Staging Testing
Color
​ServerColor · enum

Color used to identify the server in the Postmark UI.

Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange
Example: Blue

Whether sending through SMTP is enabled.

Example: true

Whether the raw email content is included in inbound webhooks.

Example: false

Webhook URL for inbound messages.

Example: https://hooks.example.com/inbound

Webhook URL for bounces (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/bounce

Webhook URL for opens (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/open

Webhook URL for deliveries (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/delivery

Webhook URL for clicks (legacy; prefer the Webhooks API).

Example: https://hooks.example.com/click

Only post the open webhook for the first open of a message.

Example: false

Your own inbound domain, with an MX record pointing to inbound.postmarkapp.com. Empty string to unset.

Example:
InboundSpamThreshold
​CreateServerRequest/properties/InboundSpamThreshold · min: 0 · max: 30

Spam score at or above which inbound messages are blocked. 0 disables blocking (valid range 0-30).

Example: 5

Track opens by default for messages sent from this server.

Example: false
TrackLinks
​TrackLinks · enum

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Enum values:
None
HtmlAndText
HtmlOnly
TextOnly
Example: HtmlAndText

Include the bounce content in bounce webhooks.

Example: true

Post SMTP API errors to the bounce webhook URL.

Example: false
ApiTokens
​string[]

Server API tokens (X-Postmark-Server-Token values).

Example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
ServerLink
​string · uri

URL of the server in the Postmark UI.

Example: https://postmarkapp.com/servers/12345/streams
InboundAddress
​string

Inbound email address of the server.

Example: xxxxxxxxxxxxxxxx@inbound.postmarkapp.com
InboundHash
​string

Hash used in the server's inbound address.

Example: xxxxxxxxxxxxxxxx
DeliveryType
​string · enum

Whether the server delivers email (Live) or runs in sandbox mode (Sandbox).

Enum values:
Live
Sandbox
Example: Live

ServerColor

string · enum
Enum values:
Purple
Blue
Turquoise
Green
Red
Yellow
Grey
Orange

Color used to identify the server in the Postmark UI.

Example: Blue

ServerList

Paged list of servers.
TotalCount
​integer · required

Number of servers matching the request.

Example: 2
​Server[] · required

Servers for the requested page.

Example: [{"ID":12345,"Name":"Staging Testing","Color":"Blue","SmtpApiActivated":true,"RawEmailEnabled":false,"InboundHookUrl":"https://hooks.example.com/inbound","BounceHookUrl":"https://hooks.example.com/bounce","OpenHookUrl":"https://hooks.example.com/open","DeliveryHookUrl":"https://hooks.example.com/delivery","ClickHookUrl":"https://hooks.example.com/click","PostFirstOpenOnly":false,"InboundDomain":"","InboundSpamThreshold":5,"TrackOpens":false,"TrackLinks":"HtmlAndText","IncludeBounceContentInHook":true,"EnableSmtpApiErrorHooks":false,"ApiTokens":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],"ServerLink":"https://postmarkapp.com/servers/12345/streams","InboundAddress":"xxxxxxxxxxxxxxxx@inbound.postmarkapp.com","InboundHash":"xxxxxxxxxxxxxxxx","DeliveryType":"Live"}]

SpamComplaintStats

Spam complaints per day.
​object[]

Per-day breakdown: spam complaints per day.

Example: [{"Date":"2026-10-01","SpamComplaint":2}]
SpamComplaint
​integer

Total complaints.

Example: 10

SpamComplaintWebhookPayload

Payload posted to a webhook for a spam complaint. Same shape as a bounce with `Type` of `SpamComplaint`.
RecordType
​string · enum · required

Always SpamComplaint.

Enum values:
SpamComplaint
Example: SpamComplaint
MessageID
​BounceWebhookPayload/properties/MessageID · uuid · required

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b
ID
​BounceWebhookPayload/properties/ID · int64 · required

Unique ID of the bounce. Field of BounceWebhookPayload.

Example: 4323372036854776000
Email
​BounceWebhookPayload/properties/Email · required

Address that bounced.

Example: john@example.com
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}

Bounce type.

Example: HardBounce

Numeric bounce type code.

Example: 1

Bounce type display name.

Example: Hard bounce

Short reason for the bounce.

Example: The server was unable to deliver your message (ex: unknown user, mailbox not found).

Detailed reason from the receiving server.

Example: Test bounce details

Sender address.

Example: sender@example.com
BouncedAt
​BounceWebhookPayload/properties/BouncedAt · date-time

Bounce time.

Example: 2026-10-06T07:25:01Z

Whether the SMTP dump can be fetched.

Example: true

Whether the address was deactivated.

Example: true

Whether the address can be reactivated.

Example: true

Subject of the original message.

Example: Test subject

ID of the server. Field of BounceWebhookPayload.

Example: 23

Full bounce content. Only present if IncludeContent is enabled.

Example: Return-Path: <>...

StandardResponse

Generic response returned by operations that only report a result code and message.
ErrorCode
​integer · required

Postmark API error code. 0 means the request succeeded. See the API error code table in the API description.

Example: 0
Message
​string · required

Human-readable result of the request.

Example: OK

SubscriptionChangeWebhookPayload

Payload posted to a webhook when a recipient's subscription status changes.
RecordType
​string · enum · required

Always SubscriptionChange.

Enum values:
SubscriptionChange
Example: SubscriptionChange
Recipient
​string · required

Recipient whose subscription changed.

Example: john@example.com
SuppressSending
​boolean · required

true when sending to the recipient is now suppressed.

Example: true
MessageID
​BounceWebhookPayload/properties/MessageID · uuid

Unique ID of the message.

Example: 927e56d4-dc66-4070-bbf0-1db76c2ae14b

ID of the server. Field of BounceWebhookPayload.

Example: 23
MessageStream
​Bounce/properties/MessageStream

Message stream the message was sent through.

Example: outbound
ChangedAt
​string · date-time

Time of the change.

Example: 2026-10-06T07:25:01Z
Origin
​SuppressionOrigin · enum

Who caused the suppression.

Enum values:
Recipient
Customer
Admin
Example: Recipient
SuppressionReason
​string | null · enum

Why the address is suppressed; null when sending is not suppressed.

Enum values:
HardBounce
SpamComplaint
ManualSuppression
Example: HardBounce

Tag of the message.

Example: welcome-user
​Metadata

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.

Example: {"color":"blue","client-id":"12345"}

SubscriptionManagementConfiguration

Unsubscribe handling settings. Relevant to Broadcast streams.
UnsubscribeHandlingType
​string · enum · required

How unsubscribes are handled. None leaves it to you, Postmark adds Postmark-hosted unsubscribe handling, Custom lets you manage unsubscribes yourself.

Enum values:
None
Postmark
Custom
Example: None

SuppressionDump

Suppression list for a message stream.
​object[] · required

Suppressed addresses on the stream.

Example: [{"EmailAddress":"address@example.com","SuppressionReason":"HardBounce","Origin":"Recipient","CreatedAt":"2026-10-06T09:15:30-04:00"}]

SuppressionOrigin

string · enum
Enum values:
Recipient
Customer
Admin

Who caused the suppression.

Example: Recipient

SuppressionReason

string · enum
Enum values:
HardBounce
SpamComplaint
ManualSuppression

Why the address is suppressed.

Example: HardBounce

Template

A full template record.
TemplateId
​integer

Unique ID of the template.

Example: 1234567

Template name.

Example: Onboarding Email

Subject template.

Example: Hello from {{company.name}}!

HTML body template.

Example: <html><body>Hello, {{name}}!</body></html>

Plain-text body template.

Example: Hello, {{name}}!
AssociatedServerId
​integer

ID of the server the template belongs to.

Example: 12345
Active
​boolean

Whether the template is active and can be used for sending.

Example: true

Unique alias used to reference the template when sending.

Example: onboarding-v1
TemplateType
​TemplateType · enum

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Enum values:
Standard
Layout
Example: Standard

Alias of the Layout template that wraps this template, if any.

Example: my-layout

TemplateList

Paged list of templates.
TotalCount
​integer · required

Number of templates matching the request.

Example: 2
​TemplateSummary[] · required

Templates for the requested page.

Example: [{"Active":true,"TemplateId":1234567,"Name":"Onboarding Email","Alias":"onboarding-v1","TemplateType":"Standard","LayoutTemplate":"my-layout"}]

TemplateSummary

Brief template details as returned in lists.

Whether the template is active.

Example: true

Unique ID of the template.

Example: 1234567

Template name.

Example: Onboarding Email

Unique alias used to reference the template when sending.

Example: onboarding-v1
TemplateType
​TemplateType · enum

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Enum values:
Standard
Layout
Example: Standard

Alias of the Layout template that wraps this template, if any.

Example: my-layout

TemplateType

string · enum
Enum values:
Standard
Layout

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Example: Standard

TemplateValidationResult

Validation result for one part of the template.
ContentIsValid
​boolean

Whether this part of the template parsed without errors.

Example: true
​object[]

Errors found.

Example: [{"Message":"The 'each' block being opened requires a model path to be specified","Line":1,"CharacterPosition":12}]
RenderedContent
​string | null

Rendered preview when a test model was supplied.

Example: Hello, bobby joe!
string · enum
Enum values:
None
HtmlAndText
HtmlOnly
TextOnly

Link tracking mode. None disables link tracking, HtmlAndText tracks links in both bodies, HtmlOnly tracks only HTML links, TextOnly tracks only plain-text links.

Example: HtmlAndText

TrackedCountsStats

Emails sent with open tracking per day.
​object[]

Per-day breakdown: emails sent with open tracking per day.

Example: [{"Date":"2026-10-01","Tracked":24}]
Tracked
​integer

Total tracked emails.

Example: 111

ValidateTemplateRequest

Template content to validate. At least one of `Subject`, `HtmlBody` or `TextBody` is required.
Subject
​string

Subject template to validate.

Example: {{#company}}{{name}}{{/company}} {{subjectHeadline}}
HtmlBody
​string

HTML body template to validate.

Example: {{#company}}{{address}}{{/company}}{{#each person}} {{name}} {{/each}}
TextBody
​string

Plain-text body template to validate.

Example: {{#company}}{{phone}}{{/company}}{{#each person}} {{name}} {{/each}}
​object

Model used to render a preview. If omitted, a suggested model is returned.

Example: {"userName":"bobby joe"}
InlineCssForHtmlTestRender
​boolean

Inline CSS when rendering the HTML preview. Defaults to true.

Example: true
TemplateType
​TemplateType · enum

Standard templates render a full message; Layout templates wrap the content of Standard templates.

Enum values:
Standard
Layout
Example: Standard

Alias of the Layout template that wraps this template, if any.

Example: my-layout

ValidateTemplateResponse

Validation outcome for a template.
AllContentIsValid
​boolean · required

true only if every supplied part is valid.

Example: true
​TemplateValidationResult

Validation result for one part of the template.

​TemplateValidationResult

Validation result for one part of the template.

Validation result for one part of the template.

​object

A model with the variables the template appears to use.

Example: {"name":"name_Value","company":{"address":"address_Value"}}

Webhook

A webhook configuration.
ID
​integer

Unique ID of the webhook. Field of Webhook.

Example: 1234567
Url
​CreateWebhookRequest/properties/Url · uri

URL Postmark posts events to.

Example: https://www.example.com/webhook-test-tracking
MessageStream
​string

Message stream the webhook belongs to.

Example: outbound
​WebhookHttpAuth

HTTP Basic Auth credentials Postmark sends with each webhook request.

​CustomHeader[]

Custom HTTP headers sent with each request.

Example: [{"Name":"X-Custom-Header","Value":"custom-value"}]
​WebhookTriggers

Events a webhook receives. In edit requests, triggers you omit are left unchanged.

Status
​string · enum

Verification status. An unverified webhook receives no events until it passes verification.

Enum values:
verified
unverified
Example: verified

WebhookHttpAuth

HTTP Basic Auth credentials Postmark sends with each webhook request.
Username
​string · required

HTTP Basic Auth username.

Example: user
Password
​string · password · required

HTTP Basic Auth password.

Example: pass

WebhookList

A list of webhooks.
​Webhook[] · required

Webhooks on the server (or the filtered stream).

Example: [{"ID":1234567,"Url":"https://www.example.com/webhook-test-tracking","MessageStream":"outbound","Status":"verified","HttpAuth":{"Username":"user","Password":"pass"},"HttpHeaders":[{"Name":"name","Value":"value"}],"Triggers":{"Open":{"Enabled":true,"PostFirstOpenOnly":false},"Click":{"Enabled":true},"Delivery":{"Enabled":true},"Bounce":{"Enabled":false,"IncludeContent":false},"SpamComplaint":{"Enabled":false,"IncludeContent":false},"SubscriptionChange":{"Enabled":false}}}]

WebhookMetrics

Delivery metrics for a webhook over the window.
TotalRequests
​integer

Total webhook requests attempted.

Example: 1000
SuccessCount
​integer

Requests that succeeded.

Example: 950
FailureCount
​integer

Requests that failed.

Example: 50
RetryCount
​integer

Requests that were retried.

Example: 20
SuccessRate
​number

Percentage of successful requests.

Example: 95
SlowCount
​integer

Requests that were slow to respond.

Example: 50
VerySlowCount
​integer

Requests that were very slow to respond.

Example: 10
AverageTerminalResponseTimeMs
​integer

Average response time in ms for terminal attempts.

Example: 255
AverageRetryResponseTimeMs
​integer | null

Average response time in ms for retried attempts; null when there were no retries.

Example: 450

WebhookStatistics

Webhook delivery statistics over a rolling 24-hour window.
WebhookId
​integer

ID of the webhook.

Example: 12345
ServerId
​integer

ID of the server. Field of WebhookStatistics.

Example: 67890
MessageStreamId
​Webhook/properties/MessageStream

Message stream the webhook belongs to.

Example: outbound
Url
​string · uri

Webhook URL.

Example: https://example.com/webhook
​object

Verification status per trigger.

Example: {"Bounce":"unverified","Delivery":"verified"}
​object

The window the statistics cover.

Example: {"StartTime":"2026-10-05T18:00:00Z","EndTime":"2026-10-06T18:00:00Z","Hours":24}
​WebhookMetrics

Delivery metrics for a webhook over the window.

​object

The same metrics broken out per trigger (for example Bounce, Delivery).

Example: {"key":{"TotalRequests":1000,"SuccessCount":950,"FailureCount":50,"RetryCount":20,"SuccessRate":95,"SlowCount":50,"VerySlowCount":10,"AverageTerminalResponseTimeMs":255,"AverageRetryResponseTimeMs":450}}

WebhookTriggers

Events a webhook receives. In edit requests, triggers you omit are left unchanged.
​object
​object
​object
​object
​object
​object

WebhookVerificationResult

Outcome of testing a webhook endpoint. A 200 HTTP status on the verify call means the check ran, not that it passed; inspect `Success`.
Id
​integer · required

ID of the webhook that was tested.

Example: 354118
Url
​string · uri · required

URL that was tested.

Example: https://www.example.com/webhook
Success
​boolean · required

true only if every enabled event returned HTTP 200.

Example: true
​object[] · required

Per-event results.

Example: [{"TriggerType":"Open","Success":true,"StatusCode":200,"Message":"Remote server returned an HTTP status code of 200."}]
Message
​string · required

Summary of the verification.

Example: 5/5 triggers verified successfully