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.
Deleting user profiles cannot be undone. The delete action permanently removes users, which may cause discrepancies in your data. For details, see the Effects of deleting user profiles section of this endpoint’s reference.
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/assets/api/openapi/users_delete.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.