Chilkat Online Tools

delphiDll / Braze Endpoints / Remove Email Addresses from Spam List

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'email','example@braze.com');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');
// Adds the "Authorization: Bearer {{api_key}}" header.
CkHttp_putAuthToken(http,'{{api_key}}');

resp := CkHttp_PostJson3(http,'https://rest.iad-01.braze.com/email/spam/remove','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

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": [
  ]
}