Get Users’ Subscription Groups

get

/subscription/user/status

Use the endpoints below to list and get the subscription groups of a certain user.

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

Parameter Required Data Type Description
api_key Yes String Your App Group REST API Key.
external_id Yes String The external_id of the user (must include at least one and at most 50 external_ids).
email Yes String The email address of the user (must include at least one address and at most 50 addresses).
limit No Integer The limit on the maximum number of results returned. Default (and max) limit is 100.
offset No Integer Number of templates to skip before returning the rest of the templates that fit the search criteria.

Example Request

1
https://rest.iad-03.braze.com/subscription/user/status?api_key=23abc-def5-3729-owod-23f9f3j30&email=example%2B1%40braze.com&subscription_group_id=14386d4a-60dd-42e2-9c94-5f2423b91d9f

Example Request for multiple users

1
https://rest.iad-03.braze.com/subscription/user/status?api_key=23abc-def5-3729-owod-23f9f3j30&external_id[]=1&external_id[]=2
WAS THIS PAGE HELPFUL?
New Stuff!