Update User's Subscription Group Status - Email
POST https://{{instance_url}}/subscription/status/set
Use the endpoint below to update the subscription state of a user on the Braze dashboard. You can access a subscription groups subscription_group_id by navigating to it on the Subscription Group page.
* email or external_id is required
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
subscription_group_id | Yes | String | The id of your subscription group, |
subscription_state | Yes | String | Available values are “unsubscribed” (not in subscription group) or “subscribed” (in subscription group) |
external_id | Yes* | String | The external_id of the user |
email | Yes* | String | The email address of the user |
phone | Optional | String in E.164 format | Tags must already exist. |
Example Successful Response
Response: (status 201)
{
"message": "success"
}
Request Body
{"subscription_group_id"=>"subscription_group_identifier", "subscription_state"=>"unsubscribed", "external_id"=>"example-user", "email"=>["example1@email.com", "example2@email.com"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |