Response Class (Status 200)
{
"InactiveMails": 0,
"Bounces": [
{
"Name": "string",
"Count": 0,
"Type": "string"
}
]
}
Already have an account? Log in →
Use our API Explorer to send API requests directly to your Postmark server or account.
These API endpoints require server level privileges using the X-Postmark-Server-Token
header parameter. Your token can be found on the credentials page in your Postmark server.
These API endpoints require account level privileges using the X-Postmark-Account-Token
header parameter. Your token can be found on the Account page on Postmark.
{
"InactiveMails": 0,
"Bounces": [
{
"Name": "string",
"Count": 0,
"Type": "string"
}
]
}
{
"TotalCount": 0,
"Bounces": [
{
"ID": "string",
"Type": "string",
"TypeCode": 0,
"Name": "string",
"Tag": "string",
"MessageID": "string",
"Description": "string",
"Details": "string",
"Email": "string",
"BouncedAt": "2025-05-29T18:10:28.554Z",
"DumpAvailable": true,
"Inactive": true,
"CanActivate": true,
"Subject": "string",
"Content": "string"
}
]
}
{
"ID": "string",
"Type": "string",
"TypeCode": 0,
"Name": "string",
"Tag": "string",
"MessageID": "string",
"Description": "string",
"Details": "string",
"Email": "string",
"BouncedAt": "2025-05-29T18:10:28.562Z",
"DumpAvailable": true,
"Inactive": true,
"CanActivate": true,
"Subject": "string",
"Content": "string"
}
{
"Body": "string"
}
{
"Message": "string",
"Bounce": {
"ID": "string",
"Type": "string",
"TypeCode": 0,
"Name": "string",
"Tag": "string",
"MessageID": "string",
"Description": "string",
"Details": "string",
"Email": "string",
"BouncedAt": "2025-05-29T18:10:28.567Z",
"DumpAvailable": true,
"Inactive": true,
"CanActivate": true,
"Subject": "string",
"Content": "string"
}
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"TotalCount": 0,
"InboundRules": [
{
"ID": 0,
"Rule": "string"
}
]
}
{
"ID": 0,
"Rule": "string"
}
{
"TotalCount": 0,
"Messages": [
{
"Tag": "string",
"MessageID": "string",
"To": [
{
"Name": "string",
"Email": "string"
}
],
"Cc": [
{
"Name": "string",
"Email": "string"
}
],
"Bcc": [
{
"Name": "string",
"Email": "string"
}
],
"Recipients": [
"string"
],
"ReceivedAt": "2025-05-29T18:10:28.580Z",
"From": "string",
"Subject": "string",
"Attachments": [
{
"Name": "string",
"Content": "string",
"ContentType": "string",
"ContentID": "string"
}
],
"Status": "string",
"TrackOpens": true,
"TrackLinks": "None"
}
]
}
{
"TextBody": "string",
"HtmlBody": "string",
"Body": "string",
"Tag": "string",
"MessageID": "string",
"To": [
{
"Name": "string",
"Email": "string"
}
],
"Cc": [
{
"Name": "string",
"Email": "string"
}
],
"Bcc": [
{
"Name": "string",
"Email": "string"
}
],
"Recipients": [
"string"
],
"ReceivedAt": "2025-05-29T18:10:28.586Z",
"From": "string",
"Subject": "string",
"Attachments": [
{
"Name": "string",
"Content": "string",
"ContentType": "string",
"ContentID": "string"
}
],
"Status": "string",
"TrackOpens": true,
"TrackLinks": "None",
"MessageEvents": [
{
"Recipient": "string",
"Type": "string",
"ReceivedAt": "2025-05-29T18:10:28.586Z",
"Details": {
"Summary": "string",
"BounceID": "string",
"DeliveryMessage": "string",
"DestinationServer": "string",
"DestinationIP": "string"
}
}
]
}
{
"Body": "string"
}
{
"TotalCount": 0,
"InboundMessages": [
{
"From": "string",
"FromName": "string",
"FromFull": {
"Email": "string",
"Name": "string"
},
"To": "string",
"ToFull": [
{
"Name": "string",
"Email": "string"
}
],
"Cc": "string",
"CcFull": [
{
"Name": "string",
"Email": "string"
}
],
"ReplyTo": "string",
"OriginalRecipient": "string",
"Subject": "string",
"Date": "string",
"MailboxHash": "string",
"Tag": "string",
"Attachments": [
{
"Name": "string",
"Content": "string",
"ContentType": "string",
"ContentID": "string"
}
],
"MessageID": "string",
"Status": "string"
}
]
}
{
"From": "string",
"FromName": "string",
"FromFull": {
"Email": "string",
"Name": "string"
},
"To": "string",
"ToFull": [
{
"Name": "string",
"Email": "string"
}
],
"Cc": "string",
"CcFull": [
{
"Name": "string",
"Email": "string"
}
],
"ReplyTo": "string",
"OriginalRecipient": "string",
"Subject": "string",
"Date": "string",
"MailboxHash": "string",
"TextBody": "string",
"HtmlBody": "string",
"Tag": "string",
"Headers": [
{
"Name": "string",
"Value": "string"
}
],
"Attachments": [
{
"Name": "string",
"Content": "string",
"ContentType": "string",
"ContentID": "string"
}
],
"MessageID": "string",
"BlockedReason": "string",
"Status": "string"
}
{
"TotalCount": 0,
"Opens": [
{
"FirstOpen": true,
"Client": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"OS": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"Platform": "string",
"UserAgent": "string",
"Geo": {
"CountryISOCode": "string",
"Country": "string",
"RegionISOCode": "string",
"Region": "string",
"City": "string",
"Zip": "string",
"Coords": "string",
"IP": "string"
},
"MessageID": "string",
"ReceivedAt": "2025-05-29T18:10:28.601Z",
"Tag": "string",
"Recipient": "string"
}
]
}
{
"TotalCount": 0,
"Opens": [
{
"FirstOpen": true,
"Client": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"OS": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"Platform": "string",
"UserAgent": "string",
"Geo": {
"CountryISOCode": "string",
"Country": "string",
"RegionISOCode": "string",
"Region": "string",
"City": "string",
"Zip": "string",
"Coords": "string",
"IP": "string"
},
"MessageID": "string",
"ReceivedAt": "2025-05-29T18:10:28.609Z",
"Tag": "string",
"Recipient": "string"
}
]
}
{
"TotalCount": 0,
"Clicks": [
{
"ClickLocation": "string",
"Client": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"OS": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"Platform": "string",
"UserAgent": "string",
"OriginalLink": "string",
"Geo": {
"CountryISOCode": "string",
"Country": "string",
"RegionISOCode": "string",
"Region": "string",
"City": "string",
"Zip": "string",
"Coords": "string",
"IP": "string"
},
"MessageID": "string",
"ReceivedAt": "2025-05-29T18:10:28.612Z",
"Tag": "string",
"Recipient": "string"
}
]
}
{
"TotalCount": 0,
"Clicks": [
{
"ClickLocation": "string",
"Client": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"OS": {
"Name": "string",
"Company": "string",
"Family": "string"
},
"Platform": "string",
"UserAgent": "string",
"OriginalLink": "string",
"Geo": {
"CountryISOCode": "string",
"Country": "string",
"RegionISOCode": "string",
"Region": "string",
"City": "string",
"Zip": "string",
"Coords": "string",
"IP": "string"
},
"MessageID": "string",
"ReceivedAt": "2025-05-29T18:10:28.619Z",
"Tag": "string",
"Recipient": "string"
}
]
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.628Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
[
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.631Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
]
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.634Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
[
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.638Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
]
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "purple",
"InboundAddress": "string",
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"SmtpApiActivated": true,
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "purple",
"InboundAddress": "string",
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"SmtpApiActivated": true,
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
{
"Sent": 0,
"Bounced": 0,
"SMTPAPIErrors": 0,
"BounceRate": 0,
"SpamComplaints": 0,
"SpamComplaintsRate": 0,
"Opens": 0,
"UniqueOpens": 0,
"Tracked": 0,
"WithOpenTracking": 0,
"WithLinkTracking": 0,
"TotalClicks": 0,
"UniqueLinksClicked": 0,
"TotalTrackedLinksSent": 0,
"WithClientRecorded": 0,
"WithPlatformRecorded": 0
}
{
"Sent": 0,
"Days": [
{
"Date": "string",
"Sent": 0
}
]
}
{
"HardBounce": 0,
"SMTPApiError": 0,
"SoftBounce": 0,
"Transient": 0,
"Days": [
{
"Date": "string",
"HardBounce": 0,
"SoftBounce": 0,
"SMTPApiError": 0,
"Transient": 0
}
]
}
{
"SpamComplaint": 0,
"Days": [
{
"Date": "string",
"SpamComplaint": 0
}
]
}
{
"Tracked": 0,
"Days": [
{
"Date": "string",
"Tracked": 0
}
]
}
{
"Opens": 0,
"Unique": 0,
"Days": [
{
"Date": "string",
"Opens": 0,
"Unique": 0
}
]
}
{
"Desktop": 0,
"WebMail": 0,
"Mobile": 0,
"Unknown": 0,
"Days": [
{
"Date": "string",
"Desktop": 0,
"WebMail": 0,
"Mobile": 0,
"Unknown": 0
}
]
}
{
"Desktop": 0,
"WebMail": 0,
"Mobile": 0,
"Unknown": 0,
"Days": [
{}
]
}
{}
{}
{}
{}
{
"Name": "string",
"Alias": "string",
"TemplateID": 0,
"HtmlBody": "string",
"TextBody": "string",
"AssociatedServerId": 0,
"Subject": "string",
"Active": true
}
{
"TotalCount": 0,
"Templates API": [
{
"Name": "string",
"Alias": "string",
"TemplateId": 0,
"Active": true
}
]
}
{
"Name": "string",
"Alias": "string",
"TemplateID": 0,
"HtmlBody": "string",
"TextBody": "string",
"AssociatedServerId": 0,
"Subject": "string",
"Active": true
}
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.692Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
[
{
"To": "string",
"SubmittedAt": "2025-05-29T18:10:28.695Z",
"MessageID": "string",
"ErrorCode": 0,
"Message": "string"
}
]
{
"Name": "string",
"Alias": "string",
"TemplateId": 0,
"Active": true
}
{
"AllContentIsValid": true,
"TextBody": {
"ContentIsValid": true,
"ValidationErrors": [
{
"Message": "string",
"Line": 0,
"CharacterPosition": 0
}
],
"RenderedContent": "string"
},
"HtmlBody": {
"ContentIsValid": true,
"ValidationErrors": [
{
"Message": "string",
"Line": 0,
"CharacterPosition": 0
}
],
"RenderedContent": "string"
},
"Subject": {
"ContentIsValid": true,
"ValidationErrors": [
{
"Message": "string",
"Line": 0,
"CharacterPosition": 0
}
],
"RenderedContent": "string"
},
"SuggestedTemplateModel": {}
}
{
"Name": "string",
"Alias": "string",
"TemplateId": 0,
"Active": true
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"TotalCount": 0,
"Domains": [
{
"Name": "string",
"SPFVerified": true,
"DKIMVerified": true,
"WeakDKIM": true,
"ReturnPathDomainVerified": true,
"ID": 0
}
]
}
{
"Name": "string",
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"Name": "string",
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"SPFHost": "string",
"SPFVerified": true,
"SPFTextValue": "string"
}
Creates a new DKIM key to replace your current key. Until the DNS entries are confirmed,
the new values will be in the DKIMPendingHost
and DKIMPendingTextValue
fields.
After the new DKIM value is verified in DNS, the pending values will migrate to
DKIMTextValue
and DKIMPendingTextValue
and Postmark will begin to sign emails
with the new DKIM key.
{
"Name": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ID": 0
}
{
"Name": "string",
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"Name": "string",
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"Name": "string",
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"TotalCount": 0,
"SenderSignatures": [
{
"Domain": "string",
"EmailAddress": "string",
"ReplyToEmailAddress": "string",
"Name": "string",
"Confirmed": true,
"ID": 0
}
]
}
{
"Domain": "string",
"EmailAddress": "string",
"ReplyToEmailAddress": "string",
"Name": "string",
"Confirmed": true,
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"Domain": "string",
"EmailAddress": "string",
"ReplyToEmailAddress": "string",
"Name": "string",
"Confirmed": true,
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"ErrorCode": 0,
"Message": "string"
}
{
"Domain": "string",
"EmailAddress": "string",
"ReplyToEmailAddress": "string",
"Name": "string",
"Confirmed": true,
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
Requests a new DKIM key to be created. Until the DNS entries are confirmed,
the new values will be in the DKIMPendingHost
and DKIMPendingTextValue
fields.
After the new DKIM value is verified in DNS, the pending values will migrate to
DKIMTextValue
and DKIMPendingTextValue
and Postmark will begin to sign emails
with the new DKIM key.
{
"ErrorCode": 0,
"Message": "string"
}
{
"Domain": "string",
"EmailAddress": "string",
"ReplyToEmailAddress": "string",
"Name": "string",
"Confirmed": true,
"SPFVerified": true,
"SPFHost": "string",
"SPFTextValue": "string",
"DKIMVerified": true,
"WeakDKIM": true,
"DKIMHost": "string",
"DKIMTestValue": "string",
"DKIMPendingHost": "string",
"DKIMPendingTextValue": "string",
"DKIMRevokedHost": "string",
"DKIMRevokedTextValue": "string",
"SafeToRemoveRevokedKeyFromDNS": true,
"DKIMUpdateStatus": "string",
"ReturnPathDomain": "string",
"ReturnPathDomainVerified": true,
"ReturnPathDomainCNAMEValue": "string",
"ID": 0
}
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "string",
"SmtpApiActivated": true,
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"InboundAddress": "string",
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
{
"TotalCount": 0,
"Servers": [
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "string",
"SmtpApiActivated": true,
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"InboundAddress": "string",
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
]
}
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "string",
"SmtpApiActivated": true,
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"InboundAddress": "string",
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
{
"ID": 0,
"Name": "string",
"ApiTokens": [
"string"
],
"ServerLink": "string",
"Color": "string",
"SmtpApiActivated": true,
"RawEmailEnabled": true,
"DeliveryHookUrl": "string",
"InboundAddress": "string",
"InboundHookUrl": "string",
"BounceHookUrl": "string",
"OpenHookUrl": "string",
"PostFirstOpenOnly": true,
"TrackOpens": true,
"TrackLinks": "None",
"ClickHookUrl": "string",
"InboundDomain": "string",
"InboundHash": "string",
"InboundSpamThreshold": 0
}
{
"TotalCount": 0,
"Templates": [
{
"Action": "string",
"TemplateId": 0,
"Alias": "string",
"Name": "string"
}
]
}
Executing this API call will make changes on your actual Postmark account and server. Are you sure you want to send this API request?