Blacklist emails
important:
Braze has released the /email/blocklist endpoint with the same functionality as the /email/blacklist endpoint. It is recommended to use the /email/blocklist endpoint instead.
Use this endpoint to unsubscribe a user from email and mark them as hard bounced.
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Request body
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
{
"email": ["blacklist_email1","blacklist_email2"]
}
Request parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
email |
Required | 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-API-KEY-HERE' \
--data-raw '{
"email": ["blacklist_email1","blacklist_email2"]
}'
Edit this page on GitHub