Delete users

Use this endpoint to delete any user profile by specifying a known user identifier.

Up to 50 external_ids, user_aliases, braze_ids, email_addresses, or phone_numbers can be included in a single request. Only one of external_ids, user_aliases, braze_ids, email_addresses, or phone_numbers can be included in a single request.

If you have a use case that can’t be solved with bulk user deletion through the API, contact the Braze Support team for assistance.

Troubleshooting

A success response was returned but the user still appears

A successful response confirms the request was queued, not that deletion is complete. Deletion typically finishes in under a second, but it can take up to five minutes for the change to propagate across all caches. If you immediately search for the user in the dashboard or export their data via the API, you may still see results during this propagation window.

If the user still exists after several minutes, verify that the identifier in your request matches the user’s actual profile:

• external_ids array: Confirm each value matches a user’s external ID exactly.
• braze_id: You can find a user’s braze_id by exporting their data with the /users/export/ids endpoint or by exporting a segment to CSV (where the braze_id appears as “Appboy ID”).
• Alias-only or email-only profiles: If the profile has no external_id, create a segment filtering for External User ID is blank combined with the known email or phone number, then export to CSV to retrieve the braze_id.

To confirm whether a user has been deleted, call the /users/export/ids endpoint using the same identifier type you used in the delete request (for example, including the value in external_ids, braze_id, or user_aliases). If the user no longer exists, the response contains "users": [] and may include "invalid_user_ids" listing that identifier.

You can download the OpenAPI document and use it to validate schemas. To learn how, see Use OpenAPI schemas for request validation.