User Delete Endpoint
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.
warning:
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 in our Help documentation.
note:
A rate limit is applied to requests made to this endpoint for customers who onboarded with Braze on or after September 16, 2021. For more information, see API Limits.
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 identifiers for the users to delete. |
user_aliases |
Optional | Array of user alias object | User aliases for the users to delete. |
braze_ids |
Optional | Array of strings | Braze user identifiers for the users to delete. |
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": ["external_identifier1", "external_identifier2"],
"user_aliases": ["user_alias1", "user_alias2"],
"braze_ids": ["braze_identifier1", "braze_identifier2"]
}'
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
}
Edit this page on GitHub