Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' Use this online tool to generate code from sample JSON: Generate Code to Create JSON
' The following JSON is sent in the request body.
' {
' "external_ids": [
' "external_identifier1",
' "external_identifier2"
' ],
' "user_aliases": [
' "user_alias1",
' "user_alias2"
' ],
' "braze_ids": [
' "braze_identifier1",
' "braze_identifier2"
' ]
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateString("external_ids[0]","external_identifier1")
success = json.UpdateString("external_ids[1]","external_identifier2")
success = json.UpdateString("user_aliases[0]","user_alias1")
success = json.UpdateString("user_aliases[1]","user_alias2")
success = json.UpdateString("braze_ids[0]","braze_identifier1")
success = json.UpdateString("braze_ids[1]","braze_identifier2")
http.SetRequestHeader "Content-Type","application/json"
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://rest.iad-01.braze.com/users/delete","application/json",json)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"
%>
</body>
</html>
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{api_key}}"
-d '{
"external_ids": ["external_identifier1", "external_identifier2"],
"user_aliases": ["user_alias1", "user_alias2"],
"braze_ids": ["braze_identifier1", "braze_identifier2"]
}'
https://rest.iad-01.braze.com/users/delete
Postman Collection Item JSON
{
"name": "User Delete",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"type": "text",
"value": "Bearer {{api_key}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"external_ids\": [\"external_identifier1\", \"external_identifier2\"],\n \"user_aliases\": [\"user_alias1\", \"user_alias2\"],\n \"braze_ids\": [\"braze_identifier1\", \"braze_identifier2\"]\n}"
},
"url": {
"raw": "https://{{instance_url}}/users/delete",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"users",
"delete"
]
},
"description": "This endpoint allows you to delete any user profile by specifying a known user identifier. Up to 50 `external_ids`, `user_aliases`, or `braze_ids` can be included in a single request. Only one of `external_ids`, `user_aliases`, or `braze_ids` can be included in a single request.\n\n> Deleting user profiles CANNOT be undone. It will PERMANENTLY remove users which may cause discrepancies in your data. Learn more about [what happens when you delete a user profile via API](https://braze.com/docs/help/help_articles/api/delete_user/) in our Help documentation.\n\n### Request Parameter\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n| `external_ids` | Optional | Array of strings | External identifiers for the users to delete |\n| `user_aliases` | Optional | Array of user alias oblect | User aliases for the users to delete |\n| `braze_ids` | Optional | Array of strings | Braze user identifiers for the users to delete |\n\n### Request Components\n- [User Alias Object](https://www.braze.com/docs/api/objects_filters/user_alias_object/)"
},
"response": [
]
}
