Classic ASP / Braze Endpoints / List User's Subscription Group - SMS
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = Server.CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("external_id","{{external_id}}")
success = queryParams.UpdateInt("limit",100)
success = queryParams.UpdateInt("offset",1)
success = queryParams.UpdateString("phone"," 11112223333")
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://rest.iad-01.braze.com/subscription/user/status",queryParams)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -G -d "external_id=%7B%7Bexternal_id%7D%7D"
-d "limit=100"
-d "offset=1"
-d "phone=%2011112223333"
-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/subscription/user/status
Postman Collection Item JSON
{
"name": "List User's Subscription Group - SMS",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"url": {
"raw": "https://{{instance_url}}/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"subscription",
"user",
"status"
],
"query": [
{
"key": "external_id",
"value": "{{external_id}}",
"description": "(Required*) String\n\nThe external_id of the user. Must include at least one and at most 50 `external_ids`."
},
{
"key": "limit",
"value": "100",
"description": "(Optional) Integer\n\nThe limit on the maximum number of results returned. Default (and max) limit is 100."
},
{
"key": "offset",
"value": "1",
"description": "(Optional) Integer\n\nNumber of templates to skip before returning rest of the templates that fit the search criteria."
},
{
"key": "phone",
"value": "+11112223333",
"description": "(Required*) String\n\nThe phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation is to provide this in the E.164 format.\n"
}
]
},
"description": "Use the endpoint below to list and get the subscription groups of a certain user.\n\n> If there are multiple users (multiple external ids) who share the same email address, all users will be returned as a separate user (even if they have the same email address or subscription group)."
},
"response": [
]
}
