User Delete
POST https://{{instance_url}}/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.
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.
Request Parameter
| 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 oblect | User aliases for the users to delete |
braze_ids | Optional | Array of strings | Braze user identifiers for the users to delete |
Request Components
Request Body
{"external_ids"=>["external_identifier1", "external_identifier2"], "user_aliases"=>["user_alias1", "user_alias2"], "braze_ids"=>["braze_identifier1", "braze_identifier2"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |