Chilkat Online Tools

Swift / Braze Endpoints / Blacklist Email Addresses

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.

    // {
    //   "email": [
    //     "blacklist_email1",
    //     "blacklist_email2"
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("email[0]", value: "blacklist_email1")
    json.UpdateString("email[1]", value: "blacklist_email2")

    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/email/blacklist", 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 '{
  "email": ["blacklist_email1","blacklist_email2"]
}'
https://rest.iad-01.braze.com/email/blacklist

Postman Collection Item JSON

{
  "name": "Blacklist Email Addresses",
  "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  \"email\": [\"blacklist_email1\",\"blacklist_email2\"]\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/email/blacklist",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "email",
        "blacklist"
      ]
    },
    "description": "Blacklisting an email address will unsubscribe the user from email and mark them as hard bounced.\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": [
  ]
}