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
Content-Type: application/json
1
2
3
4
5
6
{
  "api_key" : (required, string) App Group REST API Key,
  "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
}

Learn more about the User Alias Object here.

Response

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