Skip to content

Suppressions

Igor Balos edited this page Apr 7, 2020 · 3 revisions

For these API requests you will need to use a server API token. Once you obtain it, you will need to use server API client.

server_token = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
client = Postmark::ApiClient.new(server_token)

Get list of available suppressions

suppressions = client.dump_suppressions('outbound')

suppressions.first
# => {:email_address=>"[email protected]", :suppression_reason=>"HardBounce", :origin=>"Recipient", :created_at=>"2019-08-20T05:53:40-04:00"}

Create suppressions

You can create new suppressions by providing a message stream on a server and array of email addresses to suppress.

client.create_suppressions('outbound', ['[email protected]', '[email protected]'])

# => [{:email_address=>"[email protected]", :status=>"Suppressed"}, {:email_address=>"[email protected]", :status=>"Suppressed"}]

Delete suppressions

client.delete_suppressions('outbound', ['[email protected]', '[email protected]'])

# => [{:email_address=>"[email protected]", :status=>"Deleted"}, {:email_address=>"[email protected]", :status=>"Deleted"}]