GET email/unsubscribes

braze.com

Summary: Query List of Unsubscribed Email Addresses
Operation ID: queryListOfUnsubscribedEmailAddresses
Auth: unknown
Description

Use the /email/unsubscribes endpoint to return emails that have unsubscribed during the time period from `start_date` to `end_date`. You can use this endpoint to set up a bi-directional sync between Braze and other email systems or your own database. > You must provide either an email or a start_date and an end_date. <br><br>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.

Parameters (6)

email (string, query, optional)

(Optional*) String If provided, we will return whether or not the user has unsubscribed

end_date (string, query, optional)

(Optional*) 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 (string, query, optional)

(Optional) Integer Optional field to limit the number of results returned. Limit must be greater than 1. Defaults to 100, maximum is 500.

offset (string, query, optional)

(Optional) Integer Optional beginning point in the list to retrieve from

sort_direction (string, query, optional)

(Optional) 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.

start_date (string, query, optional)

(Optional*) 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.

No probe data for this endpoint yet.