Change Email Subscription Status
POST https://{{instance_url}}/email/status
This endpoint allows you 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.
| Parameter | Required | Data Type | Description |
|---|---|---|---|
email | Yes | String or array | String email address to modify, or an array of up to 50 email addresses to modify. |
subscription_state | Yes | String | Either “subscribed”, “unsubscribed”, or “opted_in”. |
Request Body
{"email"=>"example@braze.com", "subscription_state"=>"subscribed"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |