Postmark
Postmark API

Sender Signatures

Manage the sender signatures (From addresses) on the account. Requires an account token.


List sender signatures

GET
https://api.postmarkapp.com
/senders

Lists the sender signatures on the account with brief details. Requires an account token.

List sender signatures › query Parameters

count
​integer · min: 1 · max: 500 · required

Number of records to return per request. Max 500.

offset
​integer · min: 0 · required

Number of records to skip.

List sender signatures › Responses

A page of sender signatures.

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}]

Create a signature

POST
https://api.postmarkapp.com
/senders

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

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.

Create a signature › Responses

The created signature.

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.

Get a sender signature's details

GET
https://api.postmarkapp.com
/senders/{signatureId}

Returns all details of a sender signature, including DKIM and Return-Path state. Requires an account token.

Get a sender signature's details › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Get a sender signature's details › Responses

The signature.

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.

Edit a signature

PUT
https://api.postmarkapp.com
/senders/{signatureId}

Updates a sender signature's name, reply-to, Return-Path or confirmation note. Requires an account token.

Edit a signature › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Edit a signature › Request Body

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.

Edit a signature › Responses

The updated signature.

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.

Delete a signature

DELETE
https://api.postmarkapp.com
/senders/{signatureId}

Deletes a sender signature. Requires an account token.

Delete a signature › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Delete a signature › Responses

The signature was deleted.

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

deprecated

Request a new DKIM

POST
https://api.postmarkapp.com
/senders/{signatureId}/requestnewdkim

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.

Request a new DKIM › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Request a new DKIM › Responses

The request was processed. Check ErrorCode; 505 means a renewal is already in progress.

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

Resend a confirmation

POST
https://api.postmarkapp.com
/senders/{signatureId}/resend

Resends the confirmation email for an unconfirmed sender signature. Fails with error code 506 if it is already confirmed. Requires an account token.

Resend a confirmation › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Resend a confirmation › Responses

The confirmation was resent.

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

deprecated

Verify a signature SPF record

POST
https://api.postmarkapp.com
/senders/{signatureId}/verifyspf

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.

Verify a signature SPF record › path Parameters

signatureId
​integer · required

Unique ID of the sender signature.

Verify a signature SPF record › Responses

The signature with its refreshed SPF state.

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.