Delete user
Delete a user including all associated properties, subscriptions, and identity.
Overview
Use this API to permanently delete a user from your OneSignal project, including all associated subscriptions, properties, and aliases. The operation is asynchronous—user data will be deleted shortly after the request is accepted.
How to use this API
To delete a user, you must be able to identify them using one of the following alias types:
external_id(recommended and most common)onesignal_id- A custom Alias that you have set
Pass the appropriate alias_label and corresponding alias_id in the request path.
This operation deletes all data associated with the user, including:
- All identity aliases
- All channel subscriptions (push, email, SMS, etc.)
- All custom user properties
Because this is an irreversible operation, be sure that you really intend to delete the user and all their data.
Headers
Your App API key with prefix Key. See Keys & IDs.
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The alias name or key to locate the user. Most commonly set as external_id but can be the onesignal_id or a custom alias.
The specific identifier for the given alias to identify the user.
Response
202
The response is of type object.