You're Viewing User Model Beta Documentation 🎉

OneSignal is in the process of migrating from a device-centric model (player ID) to a new user-centric data model (OneSignal ID). In the new user-centric world, Users have a OneSignal ID, and what was the player ID is now known as the Subscription ID.

To learn more, check out the User Model Beta Overview.

Please refer to Version 9 of our documentation for device-centric information.

The Create Aliases endpoint is used to create or update an alias for a user. The alias_label and alias_id path parameters are used to identify the User. The request body must contain identity, an IdentityObject containing one or more aliases to be created.

This endpoint behaves like an upsert, i.e. if the user already has an alias with the given alias_label, the alias will be updated. If the user does not have this alias_label, the alias will be created.

onesignal_id can be used as a special alias_label, with the UUID as the alias_id. onesignal_id can not be updated.

Aliases are updated synchronously.