Domains
Manage sending domains and their DKIM and Return-Path verification. Requires an account token.
List domains
Lists the sending domains on the account. Requires an account token.
query Parameters
countNumber of records to return per request. Max 500.
offsetNumber of records to skip.
List domains › Responses
A page of domains.
TotalCountNumber of domains on the account.
Domains for the requested page.
Create a domain
Adds a sending domain to the account. Public email domains are not allowed (error code 503). Requires an account token.
Create a domain › Request Body
NameDomain name to add.
ReturnPathDomainCustom Return-Path subdomain of the domain, with a CNAME pointing to pm.mtasv.net.
Create a domain › Responses
The created domain with the DNS records to configure.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Get a domain's details
Returns a domain with its DKIM and Return-Path verification details. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Get a domain's details › Responses
The domain.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Edit a domain
Updates a domain's custom Return-Path. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Edit a domain › Request Body
ReturnPathDomainNew custom Return-Path subdomain.
Edit a domain › Responses
The updated domain.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Delete a domain
Removes a domain from the account. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Delete a domain › Responses
The domain was deleted.
ErrorCodePostmark API error code. 0 means the request succeeded. See the API error code table in the API description.
MessageHuman-readable result of the request.
Verify DKIM status
Checks DNS for the domain's DKIM record and updates its verification state. Check DKIMVerified in the response. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Verify DKIM status › Responses
The domain with its refreshed DKIM state.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Verify Return-Path status
Checks DNS for the domain's custom Return-Path CNAME and updates its verification state. Check ReturnPathDomainVerified in the response. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Verify Return-Path status › Responses
The domain with its refreshed Return-Path state.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Rotate DKIM keys
Starts DKIM key rotation: a new key appears in the DKIMPending* fields until its DNS record is confirmed, then Postmark starts signing with it. Fails with error code 505 if a rotation is already in progress. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Rotate DKIM keys › Responses
The domain with the pending DKIM key.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Verify a domain SPF record
Checks DNS for an SPF record that includes Postmark's servers. Postmark no longer requires SPF records, so this check is optional. Requires an account token.
path Parameters
domainIdUnique ID of the domain.
Verify a domain SPF record › Responses
The domain with its refreshed SPF state.
IDUnique ID of the domain. Field of Domain.
NameDomain name.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.