Unicode C++ / Braze Endpoints / Update User's Subscription Group Status - SMS
Back to Collection Items
void ChilkatSample(void)
{
json.UpdateString(L"subscription_group_id",L"subscription_group_identifier"); json.UpdateString(L"subscription_state",L"unsubscribed"); json.UpdateString(L"external_id",L"external_identifier"); json.UpdateString(L"phone[0]",L"+12223334444"); json.UpdateString(L"phone[1]",L"+11112223333"); http.put_AuthToken(L"{{api_key}}");
}
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": [
]
}