Blacklist Emails
Blacklisting an email address will unsubscribe the user from email and mark them as hard bounced.
important:
Looking for the api_key parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY within the Example Request below.
Braze will continue to support the api_key being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
Request Body
1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
{
"email": "email@address.com"
}
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
email |
Yes | String or Array | String email address to blacklist, or an array of up to 50 email addresses to blacklist. |
Example Request
1
2
3
4
5
6
curl --location --request POST 'https://rest.iad-01.braze.com/email/blacklist' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"email": ["EMAIL_TO_BLACKLIST_1","EMAIL_TO_BLACKLIST_2"]
}'
Edit this page on GitHub