Change email subscription status
Use this endpoint to set the email subscription state for your users.
Users can be opted_in, unsubscribed, or subscribed (not specifically opted in or out).
You can set the email subscription state for an email address that is not yet associated with any of your users within Braze. When that email address is subsequently associated with a user, the email subscription state that you uploaded will be automatically set.
Prerequisites
To use this endpoint, you’ll need an API key with the email.status permission.
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
4
{
"email": "[email protected]",
"subscription_state": "subscribed"
}
Request parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
email |
Required | String or array | String email address to modify, or an array of up to 50 email addresses to modify. |
subscription_state |
Required | String | Either “subscribed”, “unsubscribed”, or “opted_in”. |
Example request
1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/email/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
"email": "[email protected]",
"subscription_state": "subscribed"
}'
Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!