Skip to main content
GET
/
suppressions
Ruby
Helo.configure do |config|
  config.access_token = "YOUR_BEARER_TOKEN"
end

opts = {
  channel_id: "550e8400-e29b-41d4-a716-446655440000",
  email: "example",
  limit: 10,
  offset: 10
}
Helo::Suppressions.list(opts)
{
  "totalCount": 123,
  "results": [
    {
      "email": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

channelId
string<uuid>
required
mailType
enum<string>
required
Available options:
transactional,
broadcast
reason
enum<string>
Available options:
bounce,
complaint,
unsubscribe,
manual
email
string
limit
integer<int32>
Required range: 1 <= x <= 500
offset
integer<int32>
Required range: x >= 0

Response

OK

totalCount
integer<int32>
required
results
object[]
required