phpExt / Braze Endpoints / Remove Email Addresses from Spam List
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new 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"
// }
$json = new CkJsonObject();
$json->UpdateString('email','example@braze.com');
$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/spam/remove','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
print $resp->get_StatusCode() . "\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"
}'
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": [
]
}