Sign in

v1

latestSwagger 2.02026-07-13434569.6 KB
Bounces API

Get bounces

get/bounces

Query parameters

countinteger required

Number of bounces to return per request. Max 500.

offsetinteger required

Number of bounces to skip.

type'HardBounce' | 'Transient' | 'Unsubscribe' | 'Subscribe' | 'AutoResponder' | 'AddressChange' | 'DnsError' | 'SpamNotification' | 'OpenRelayTest' | 'Unknown' | 'SoftBounce' | 'VirusNotification' | 'MailFrontier Matador.' | 'BadEmailAddress' | 'SpamComplaint' | 'ManuallyDeactivated' | 'Unconfirmed' | 'Blocked' | 'SMTPApiError' | 'InboundError' | 'DMARCPolicy' | 'TemplateRenderingFailed'

Filter by type of bounce

inactiveboolean

Filter by emails that were deactivated by Postmark due to the bounce. Set to true or false. If this isn't specified it will return both active and inactive.

emailFilterstring email

Filter by email address

messageIDstring

Filter by messageID

tagstring

Filter by tag

todatestring date

Filter messages up to the date specified. e.g. 2014-02-01

fromdatestring date

Filter messages starting from the date specified. e.g. 2014-02-01

Headers

X-Postmark-Server-Tokenstring required

The token associated with the Server on which this request will operate.

Response

OK

TotalCountinteger