Chilkat Online Tools

lianja / Braze Endpoints / Remove Email Addresses from Spam List

Back to Collection Items

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

loHttp = createobject("CkHttp")

// 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"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("email","example@braze.com")

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

loResp = loHttp.PostJson3("https://rest.iad-01.braze.com/email/spam/remove","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

Curl Command

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

Postman Collection Item JSON

{
  "name": "Remove Email Addresses from Spam List",
  "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}"
    },
    "url": {
      "raw": "https://{{instance_url}}/email/spam/remove",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "email",
        "spam",
        "remove"
      ]
    },
    "description": "This endpoint allows you to remove email addresses from your Braze spam list. We will also remove them from the spam list maintained by your email provider.\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. |"
  },
  "response": [
  ]
}