Sender Signatures
Manage the sender signatures (From addresses) on the account. Requires an account token.
List sender signatures
Lists the sender signatures on the account with brief details. Requires an account token.
query Parameters
countNumber of records to return per request. Max 500.
offsetNumber of records to skip.
List sender signatures › Responses
A page of sender signatures.
TotalCountNumber of signatures on the account.
Signatures for the requested page.
Create a signature
Creates a sender signature and emails a confirmation to the address. The signature cannot send until confirmed. Requires an account token.
Create a signature › Request Body
FromEmailEmail address of the signature.
NameFrom name.
ReplyToEmailReply-To override address.
ReturnPathDomainCustom Return-Path subdomain with a CNAME to pm.mtasv.net.
ConfirmationPersonalNoteNote shown in the confirmation email. Max 400 characters.
Create a signature › Responses
The created signature.
IDUnique ID of the signature.
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignature.
ReplyToEmailAddressReply-To address. Field of SenderSignature.
From name.
ConfirmedWhether the signature has been confirmed.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
ConfirmationPersonalNotePersonal note shown to the confirmation email recipient.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Get a sender signature's details
Returns all details of a sender signature, including DKIM and Return-Path state. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Get a sender signature's details › Responses
The signature.
IDUnique ID of the signature.
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignature.
ReplyToEmailAddressReply-To address. Field of SenderSignature.
From name.
ConfirmedWhether the signature has been confirmed.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
ConfirmationPersonalNotePersonal note shown to the confirmation email recipient.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Edit a signature
Updates a sender signature's name, reply-to, Return-Path or confirmation note. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Edit a signature › Request Body
NameFrom name. Field of EditSenderSignatureRequest.
ReplyToEmailReply-To override address. Field of EditSenderSignatureRequest.
ReturnPathDomainCustom Return-Path subdomain with a CNAME to pm.mtasv.net.
ConfirmationPersonalNoteNote shown in the confirmation email. Max 400 characters. Field of EditSenderSignatureRequest.
Edit a signature › Responses
The updated signature.
IDUnique ID of the signature.
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignature.
ReplyToEmailAddressReply-To address. Field of SenderSignature.
From name.
ConfirmedWhether the signature has been confirmed.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
ConfirmationPersonalNotePersonal note shown to the confirmation email recipient.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.
Delete a signature
Deletes a sender signature. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Delete a signature › Responses
The signature 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.
Request a new DKIM
Deprecated. Use Rotate DKIM keys in the Domains API instead. Creates a new DKIM key that stays in the DKIMPending* fields until its DNS record is confirmed. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Request a new DKIM › Responses
The request was processed. Check ErrorCode; 505 means a renewal is already in progress.
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.
Resend a confirmation
Resends the confirmation email for an unconfirmed sender signature. Fails with error code 506 if it is already confirmed. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Resend a confirmation › Responses
The confirmation was resent.
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 a signature SPF record
Deprecated. Postmark no longer asks for SPF records. Queries DNS and checks that the SPF record includes Postmark's servers; see SPFVerified in the response. Requires an account token.
path Parameters
signatureIdUnique ID of the sender signature.
Verify a signature SPF record › Responses
The signature with its refreshed SPF state.
IDUnique ID of the signature.
DomainDomain of the signature.
EmailAddressSender email address. Field of SenderSignature.
ReplyToEmailAddressReply-To address. Field of SenderSignature.
From name.
ConfirmedWhether the signature has been confirmed.
SPFHostHost name for the optional SPF configuration.
SPFTextValueOptional SPF TXT value.
DKIMVerifiedWhether DKIM has ever been verified. Stays true even if the record is later removed from DNS.
WeakDKIMtrue if the DKIM key is weaker than 1024 bit; rotate the key to upgrade it.
DKIMHostDNS TXT host currently used to validate DKIM.
DKIMTextValueDNS TXT value currently used to validate DKIM.
DKIMPendingHostPending DKIM TXT host not yet confirmed in DNS (after rotation or for a new domain).
DKIMPendingTextValuePending DKIM TXT value not yet confirmed in DNS.
DKIMRevokedHostRevoked DKIM TXT host that will be removed.
DKIMRevokedTextValueRevoked DKIM TXT value that will be removed.
SafeToRemoveRevokedKeyFromDNStrue when the old DKIM records can be safely deleted from DNS.
DKIMUpdateStatusPending while a new DKIM key is being set up or rotated, Verified once DNS is up to date.
ReturnPathDomainCustom Return-Path domain.
ReturnPathDomainVerifiedWhether the Return-Path CNAME is verified and in use.
ReturnPathDomainCNAMEValueCNAME value Postmark expects at the Return-Path domain.
ConfirmationPersonalNotePersonal note shown to the confirmation email recipient.
SPFVerifiedDeprecated. Postmark no longer requires an SPF record.