Chilkat Online Tools

Swift / Braze Endpoints / Update User's Subscription Group Status - Email

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    // 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": "example-user",
    //   "email": [
    //     "example1@email.com",
    //     "example2@email.com"
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("subscription_group_id", value: "subscription_group_identifier")
    json.UpdateString("subscription_state", value: "unsubscribed")
    json.UpdateString("external_id", value: "example-user")
    json.UpdateString("email[0]", value: "example1@email.com")
    json.UpdateString("email[1]", value: "example2@email.com")

    http.SetRequestHeader("Content-Type", value: "application/json")
    // Adds the "Authorization: Bearer {{api_key}}" header.
    http.AuthToken = "{{api_key}}"

    var resp: CkoHttpResponse? = http.PostJson3("https://rest.iad-01.braze.com/subscription/status/set", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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": "example-user",
  "email": ["example1@email.com", "example2@email.com"]
}'
https://rest.iad-01.braze.com/subscription/status/set

Postman Collection Item JSON

{
  "name": "Update User's Subscription Group Status - Email",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"subscription_group_id\": \"subscription_group_identifier\",\n  \"subscription_state\": \"unsubscribed\",\n  \"external_id\": \"example-user\",\n  \"email\": [\"example1@email.com\", \"example2@email.com\"]\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\\* `email` or `external_id` is required\n\n### Request Parameters\n\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": [
  ]
}