TCL / Braze Endpoints / Blacklist Email Addresses
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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": [
# "blacklist_email1",
# "blacklist_email2"
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "email[0]" "blacklist_email1"
CkJsonObject_UpdateString $json "email[1]" "blacklist_email2"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# Adds the "Authorization: Bearer {{api_key}}" header.
CkHttp_put_AuthToken $http "{{api_key}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://rest.iad-01.braze.com/email/blacklist" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
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": [
]
}