Get Users’ Subscription Group Status

Use the endpoints below to get the subscription state of a user in a subscription group. These groups will be available on the Subscription Group page. The response from this endpoint will include the external ID and either subscribed, unsubscribed, or unknown for the specific subscription group requested in the API call. This can be used to update the subscription group state in subsequent API calls or to be displayed on a hosted web page.

If you want to see examples or test this endpoint for Email Subscription Groups:

If you want to see examples or test this endpoint for SMS Subscription Groups:

Request Parameters

Generally, either external_id or email is required.

For SMS subscription groups, either external_id or phone is required.

Your request must include phone or email value, but not both.

Example Request

1
https://rest.iad-03.braze.com/subscription/user/status?api_key=23abc-def5-3729-owod-23f9f3j30&subscription_group_id=1f3-33203-3dd3-d323d3&email=example%2B1%40braze.com

Example Request for multiple users

1
https://rest.iad-03.braze.com/subscription/user/status?api_key=23abc-def5-3729-owod-23f9f3j30&subscription_group_id=1f3-33203-3dd3-d323d3&&external_id[]=1&external_id[]=2

Response

All successful responses will return subscribed, unsubscribed, or unknown depending on status and user history with the subscription group.

1
2
3
4
5
6
7
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}