Remove a specific alias from a user.
Overview
Use this API to remove aliases from a user's identity object.
This API does not delete users. See Delete user API to delete the user and all associated properties, identity, and subscriptions.
How to use this API
In the path parameters, set the alias in which to identify the user as the alias_label and its associated ID in the alias_id.
The alias_label_to_delete can match the alias_label used to identify the user. This action is performed synchronously, ensuring that the alias is deleted immediately.
Please note that the onesignal_id alias can not be deleted; only other aliases can be removed. See Users and Aliases for more details.
FAQ
Can I delete the same alias that I am using to lookup the user?
Yes, this is common in cases where a mistake has been made in setting the wrong alias. However, if you are wanting to delete the user along with all aliases and subscriptions associated, use the Delete user API.
What happens if I delete all the aliases associated with the user?
A user will always have at least 1 alias, the OneSignal ID. If you removed all aliases tied to a user, then all subscriptions will still be associated with that OneSignal ID.