User Delete Endpoint

post

/users/delete


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. Please note that users’ associated event data will still exist in the dashboard after you delete the user(s).

Request Body

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
{
  "external_ids" : (optional, array of string) external ids for the users to delete,
  "user_aliases" : (optional, array of User Alias objects) User Aliases for the users to delete,
  "braze_ids" : (optional, array of string) Braze User Identifiers for the users to delete
}

Request Parameters

Parameter Required Data Type Description
external_ids Optional Array of Strings External ids for the users to delete
user_aliases Optional Array of User Alias Objects User Aliases for the users to delete
braze_ids Optional Array of Strings Braze User Identifiers for the users to delete

Request Components

Example Request

1
2
3
4
5
6
7
8
curl --location --request POST 'https://rest.iad-01.braze.com/users/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "external_ids": ["user_id1", "user_id2"],
  "user_aliases": ["user_alias1", "user_alias2"],
  "braze_ids": ["braze_id1", "braze_id2"]
}'

Response

1
2
3
4
5
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
  "deleted" : (required, integer) number of user ids queued for deletion
}
WAS THIS PAGE HELPFUL?
New Stuff!