Retrieve List of or Query Email Unsubscribes

get

/email/unsubscribes

Users’ email subscription status can be updated and retrieved via Braze using a RESTful API. You can use the API to set up bi-directional sync between Braze and other email systems or your own database. All API requests are made over HTTPS.

Request Parameters

You must provide an end_date, as well as either an email or a start_date .

Parameter Required Data Type Description
start_date No * String in YYYY-MM-DD format Start date of the range to retrieve unsubscribes, must be earlier than end_date. This is treated as midnight in UTC time by the API.
end_date No * String in YYYY-MM-DD format End date of the range to retrieve unsubscribes. This is treated as midnight in UTC time by the API.
limit No Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500.
offset No Integer Optional beginning point in the list to retrieve from
sort_direction No String Pass in the value asc to sort unsubscribes from oldest to newest. Pass in desc to sort from newest to oldest. If sort_direction is not included, the default order is newest to oldest.
email No * String If provided, we will return whether or not the user has unsubscribed

If your date range has more than limit number of unsubscribes, 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/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=0&offset=1&sort_direction=desc&email=foo@braze.com' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Sample 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": "foo@braze.com",
      "unsubscribed_at": "2016-08-25 15:24:32 +0000"
    },
    {
      "email": "bar@braze.com",
      "unsubscribed_at": "2016-08-24 17:41:58 +0000"
    },
    {
      "email": "baz@braze.com",
      "unsubscribed_at": "2016-08-24 12:01:13 +0000"
    }
  ],
  "message": "success"
}
WAS THIS PAGE HELPFUL?
New Stuff!