Classic ASP / Braze Endpoints / Update User's Subscription Group Status - 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")
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "subscription_group_id": "subscription_group_identifier",
' "subscription_state": "unsubscribed",
' "external_id": "external_identifier",
' "phone": [
' "+12223334444",
' "+11112223333"
' ]
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateString("subscription_group_id","subscription_group_identifier")
success = json.UpdateString("subscription_state","unsubscribed")
success = json.UpdateString("external_id","external_identifier")
success = json.UpdateString("phone[0]","+12223334444")
success = json.UpdateString("phone[1]","+11112223333")
http.SetRequestHeader "Content-Type","application/json"
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://rest.iad-01.braze.com/subscription/status/set","application/json",json)
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 -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{api_key}}"
-d '{
"subscription_group_id": "subscription_group_identifier",
"subscription_state": "unsubscribed",
"external_id": "external_identifier",
"phone": ["+12223334444", "+11112223333"]
}'
https://rest.iad-01.braze.com/subscription/status/set
Postman Collection Item JSON
{
"name": "Update User's Subscription Group Status - SMS",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"subscription_group_id\": \"subscription_group_identifier\",\n \"subscription_state\": \"unsubscribed\",\n \"external_id\": \"external_identifier\",\n \"phone\": [\"+12223334444\", \"+11112223333\"]\n}\n"
},
"url": {
"raw": "https://{{instance_url}}/subscription/status/set",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"subscription",
"status",
"set"
]
},
"description": "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.\n\n> Only `external_id` or `phone` is accepted for SMS subscription groups.\n\n### Request Parameters\n| Parameter | Required | Data Type | Description |\n|---|---|---|---|\n| `subscription_group_id` | Yes | String | The id of your subscription group, |\n| `subscription_state` | Yes | String | Available values are “unsubscribed” (not in subscription group) or “subscribed” (in subscription group) |\n| `external_id` | Yes* | String | The external_id of the user |\n| `email` | Yes* | String | The email address of the user |\n| `phone` | Optional | String in E.164 format | Tags must already exist. |\n\n### Example Successful Response\n\nResponse: (status 201)\n\n```json\n{\n \"message\": \"success\"\n}\n```"
},
"response": [
]
}
