Domains API

Lets you manage all of your domain details for a specific account.

List domains Try → #

get

/domains

Gets a list of domains containing an overview of the domain and authentication status.

Request headers

Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains?count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Postmark-Account-Token: account token"

Querystring parameters

count	required Number of records to return per request. Max 500.
offset	required Number of records to skip.

Response

TotalCount	integer	Indicates how many domains match the search criteria you specified. This can be more than what is fetched by a single call.
Domains	array	List of objects that each represent a domain.
Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalCount": 2,
  "Domains": [
    {
      "Name": "postmarkapp.com",
      "SPFVerified": true,
      "DKIMVerified": true,
      "WeakDKIM": false,
      "ReturnPathDomainVerified": false,
      "ID": 36735
    },
    {
      "Name": "example.com",
      "SPFVerified": true,
      "DKIMVerified": true,
      "WeakDKIM": false,
      "ReturnPathDomainVerified": true,
      "ID": 81605
    }
  ]
}

Get a domain’s details Try → #

get

/domains/{domainid}

Gets all the details for a specific domain.

Request headers

Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Postmark-Account-Token: account token"

Response

Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
SPFHost	string	Host name used for the SPF configuration.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ReturnPathDomain	string	The custom Return-Path for this domain, please read our support page.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ReturnPathDomainCNAMEValue	string	The CNAME DNS record that Postmark expects to find at the ReturnPathDomain value.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Name": "postmarkapp.com",
  "SPFVerified": true,
  "SPFHost": "postmarkapp.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.postmarkapp.com",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "DKIMPendingHost": "20131031155228pm._domainkey.postmarkapp.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.postmarkapp.com",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36735
}

Create a domain Try → #

post

/domains

Request headers

Content-Type	required application/json
Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Postmark-Account-Token: account token" \
  -d '{
  "Name": "example.com",
  "ReturnPathDomain": "pm-bounces.example.com"
}'

Body format

Name	string	required Domain name
ReturnPathDomain	string	A custom value for the Return-Path domain. It is an optional field, but it must be a subdomain of your From Email domain and must have a CNAME record that points to `pm.mtasv.net`. For more information about this field, please read our support page.

Example body format

{
  "Name": "example.com",
  "ReturnPathDomain": "pm-bounces.example.com"
}

Response

Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
SPFHost	string	Host name used for the SPF configuration.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ReturnPathDomain	string	The custom Return-Path for this domain, please read our support page.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ReturnPathDomainCNAMEValue	string	The CNAME DNS record that Postmark expects to find at the ReturnPathDomain value.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Name": "newdomain.com",
  "SPFVerified": false,
  "SPFHost": "newdomain.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "",
  "DKIMTextValue": "",
  "DKIMPendingHost": "20131031155228pm._domainkey.newdomain.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.newdomain.com",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36736
}

Edit a domain Try → #

put

/domains/{domainid}

Request headers

Content-Type	required application/json
Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}" \
  -X PUT \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Postmark-Account-Token: account token" \
  -d '{
  "ReturnPathDomain": "pm-bounces.example.com"
}'

Body format

ReturnPathDomain	string	A custom value for the Return-Path domain. It is an optional field, but it must be a subdomain of your From Email domain and must have a CNAME record that points to `pm.mtasv.net`. For more information about this field, please read our support page.

Example body format

{
  "ReturnPathDomain": "pm-bounces.example.com"
}

Response

Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
SPFHost	string	Host name used for the SPF configuration.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ReturnPathDomain	string	The custom Return-Path for this domain, please read our support page.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ReturnPathDomainCNAMEValue	string	The CNAME DNS record that Postmark expects to find at the ReturnPathDomain value.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Name": "example.com",
  "SPFVerified": false,
  "SPFHost": "example.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "20160921046319pm._domainkey.example.com",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GDRrFQJc5dZEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMPendingHost": "20131031155228pm._domainkey.example.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36736
}

Delete a domain Try → #

delete

/domains/{domainid}

Request headers

Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}" \
  -X DELETE \
  -H "Accept: application/json" \
  -H "X-Postmark-Account-Token: account token"

Response

ErrorCode	integer	API Error Codes
Message	string	Response message

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 0,
  "Message": "Domain example.com removed."
}

Verify DKIM Status Try → #

put

/domains/{domainid}/verifyDkim

Verify DKIM keys for the specified domain.

Request headers

Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}/verifyDkim" \
  -X PUT \
  -H "Accept: application/json" \
  -H "X-Postmark-Account-Token: account token" \
  -d ""

Response

Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
SPFHost	string	Host name used for the SPF configuration.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ReturnPathDomain	string	The custom Return-Path for this domain, please read our support page.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ReturnPathDomainCNAMEValue	string	The CNAME DNS record that Postmark expects to find at the ReturnPathDomain value.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Name": "postmarkapp.com",
  "SPFVerified": true,
  "SPFHost": "postmarkapp.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.postmarkapp.com",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "DKIMPendingHost": "20131031155228pm._domainkey.postmarkapp.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.postmarkapp.com",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36735
}

Verify Return-Path Status Try → #

put

/domains/{domainid}/verifyReturnPath

Verify Return-Path DNS record for the specified domain.

Request headers

Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}/verifyReturnPath" \
  -X PUT \
  -H "Accept: application/json" \
  -H "X-Postmark-Account-Token: account token"

Response

Name	string	Domain name
SPFVerified	boolean	deprecated See our blog post to learn why this field was deprecated.
SPFHost	string	Host name used for the SPF configuration.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ReturnPathDomain	string	The custom Return-Path for this domain, please read our support page.
ReturnPathDomainVerified	boolean	The verification state of the Return-Path domain. Tells you if the Return-Path is actively being used or still needs further action to be used.
ReturnPathDomainCNAMEValue	string	The CNAME DNS record that Postmark expects to find at the ReturnPathDomain value.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Name": "postmarkapp.com",
  "SPFVerified": true,
  "SPFHost": "postmarkapp.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.postmarkapp.com",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "DKIMPendingHost": "20131031155228pm._domainkey.postmarkapp.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.postmarkapp.com",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36735
}

Verify an SPF record Try → #

post

/domains/{domainid}/verifyspf

deprecated This method has been deprecated. See our blog post for why we no longer ask for SPF records.

Will query DNS for your domain and attempt to verify the SPF record contains the information for Postmark's servers.

Request headers

Content-Type	required application/json
Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}/verifyspf" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Postmark-Account-Token: account token"

Response

The SPFVerified field that is returned will indicate whether or not SPF validation was successful.

SPFHost	string	Host name used for the SPF configuration.
SPFVerified	boolean	SPF DNS text record has been setup correctly at your domain registrar or DNS host.
SPFTextValue	string	Value that can be optionally setup with your DNS host. See our blog post to learn why this field is no longer necessary.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "SPFHost": "example.com",
  "SPFVerified": true,
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all"
}

Rotate DKIM keys Try → #

post

/domains/{domainid}/rotatedkim

Creates a new DKIM key to replace your current key. Until the new DNS entries are confirmed, the pending values will be in 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.

Request headers

Content-Type	required application/json
Accept	required application/json
X-Postmark-Account-Token	required This request requires account level privileges. Only accessible by the account owner, this token can be found on the API Tokens tab of your Postmark account.

Example request with curl

curl "https://api.postmarkapp.com/domains/{domainid}/rotatedkim" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Postmark-Account-Token: account token"

Response

Name	string	Domain name
DKIMVerified	boolean	Specifies whether DKIM has ever been verified for the domain or not. Once DKIM is verified, this response will stay true, even if the record is later removed from DNS.
WeakDKIM	boolean	DKIM is using a strength weaker than 1024 bit. If so, it’s possible to request a new DKIM using the RequestNewDKIM function below.
DKIMHost	string	DNS TXT host being used to validate messages sent in.
DKIMTextValue	string	DNS TXT value being used to validate messages sent in.
DKIMPendingHost	string	If a DKIM rotation has been intiated or this DKIM is from a new Domain, this field will show the pending DKIM DNS TXT host which has yet to be setup and confirmed at your registrar or DNS host.
DKIMPendingTextValue	string	Similar to the DKIMPendingHost field, this will show the DNS TXT value waiting to be confirmed at your registrar or DNS host.
DKIMRevokedHost	string	Once a new DKIM has been confirmed at your registrar or DNS host, Postmark will revoke the old DKIM host in preparation for removing it permantly from the system.
DKIMRevokedTextValue	string	Similar to DKIMRevokedHost, this field will show the DNS TXT value that will soon be removed from the Postmark system.
SafeToRemoveRevokedKeyFromDNS	boolean	Indicates whether you may safely delete the old DKIM DNS TXT records at your registrar or DNS host. The new DKIM is now safely in use.
DKIMUpdateStatus	string	While DKIM renewal or new DKIM operations are being conducted or setup, this field will indicate `Pending`. After all DNS TXT records are up to date and any pending renewal operations are finished, it will indicate `Verified`.
ID	integer	Unique ID of the Domain.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Name": "postmarkapp.com",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.postmarkapp.com",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "DKIMPendingHost": "20131031155228pm._domainkey.postmarkapp.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ID": 36735
}

Overview

Integration

User guide

API reference

Webhooks

Domains API

List domains Try → #

/domains

Request headers

Example request with curl

Querystring parameters

Response

Example response

Get a domain’s details Try → #

/domains/{domainid}

Request headers

Example request with curl

Response

Example response

Create a domain Try → #

/domains

Request headers

Example request with curl

Body format

Example body format

Response

Example response

Edit a domain Try → #

/domains/{domainid}

Request headers

Example request with curl

Body format

Example body format

Response

Example response

Delete a domain Try → #

/domains/{domainid}

Request headers

Example request with curl

Response

Example response

Verify DKIM Status Try → #

/domains/{domainid}/verifyDkim

Request headers

Example request with curl

Response

Example response

Verify Return-Path Status Try → #

/domains/{domainid}/verifyReturnPath

Request headers

Example request with curl

Response

Example response

Verify an SPF record Try → #

/domains/{domainid}/verifyspf

Request headers

Example request with curl

Response

Example response

Rotate DKIM keys Try → #

/domains/{domainid}/rotatedkim

Request headers

Example request with curl

Response

Example response