Query or List Hard Bounced Emails

get

/email/hard_bounces

This endpoint allows you to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame.

Request Parameters

You must provide either a start_date and end_date OR an email.

If you provide a start_date, end_date, and an email, we prioritize the email(s) given and disregard the date range.

Parameter Required Data Type Description
start_date Optional* String in YYYY-MM-DD format Start date of the range to retrieve hard bounces, must be earlier than end_date. This is treated as midnight in UTC time by the API.
end_date Optional* String in YYYY-MM-DD format End date of the range to retrieve hard bounces. This is treated as midnight in UTC time by the API.
limit Optional Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500.
offset Optional Integer Optional beginning point in the list to retrieve from
email Optional* String If provided, we will return whether or not the user has hard bounced

If your date range has more than the limit number of hard bounces, you will need to make multiple API calls, each time increasing the offset until a call returns either fewer than limit or zero results.

Example Request

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&email=example@braze.com' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Response

Entries are listed in descending order.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "emails": [
    {
      "email": "example1@braze.com",
      "hard_bounced_at": "2016-08-25 15:24:32 +0000"
    },
    {
      "email": "example2@braze.com",
      "hard_bounced_at": "2016-08-24 17:41:58 +0000"
    },
    {
      "email": "example3@braze.com",
      "hard_bounced_at": "2016-08-24 12:01:13 +0000"
    }
  ],
  "message": "success"
}
WAS THIS PAGE HELPFUL?
New Stuff!