Chilkat Online Tools

Ruby / Braze Endpoints / Change Email Subscription Status

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "email": "example@braze.com",
#   "subscription_state": "subscribed"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("email","example@braze.com")
json.UpdateString("subscription_state","subscribed")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://rest.iad-01.braze.com/email/status","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{api_key}}"
	-d '{
  "email": "example@braze.com",
  "subscription_state": "subscribed"
}'
https://rest.iad-01.braze.com/email/status

Postman Collection Item JSON

{
  "name": "Change Email Subscription Status",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"email\": \"example@braze.com\",\n  \"subscription_state\": \"subscribed\"\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/email/status",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "email",
        "status"
      ]
    },
    "description": "This endpoint allows you to set the email subscription state for your users. Users can be opted_in, unsubscribed, or subscribed (not specifically opted in or out).\n\nYou can set the email subscription state for an email address that is not yet associated with any of your users within Braze. When that email address is subsequently associated with a user, the email subscription state that you uploaded will be automatically set.\n\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n| `email` | Yes | String or array | String email address to modify, or an array of up to 50 email addresses to modify. |\n| `subscription_state` | Yes | String | Either “subscribed”, “unsubscribed”, or “opted_in”. |"
  },
  "response": [
  ]
}