Update an existing user by its alias
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.
Caution when combining with Pre-User Model APIs
If you are still using the pre-User Model APIs or SDKs (Mobile SDKs 4 or less, Web SDK 15 or less), then we advise testing this endpoint before switching. There may be cases where the External ID set with the SDK and the External ID set with the API do not produce matching OneSignal IDs.
If you are still using pre-User Model SDKs (Mobile SDKs 4 or less, Web SDK 15 or less), you should consider either:
- updating to the the User Model SDKs (Mobile SDK 5+, Web SDK 16+). See User Model Migration Guide for details.
- Or continue to use the Add a device, Edit tags with external user id, and Edit device APIs until you migrate the SDKs.
Update a user identified by alias_label and alias_id path parameters. Properties are updated asynchronously.
onesignal_id can be used as a special alias_label, using the string "onesignal_id" as the alias_label and the UUID as the alias_id.