Transfer the given subscription to a different user. The subscription_id in the path parameters is used to identify the subscription to move. The IdentityObject in the request body will identify the target user that the subscription is moved to. This IdentityObject must contain exactly one alias, which may be onesignal_id. The transfer is completed synchronously. A user can have at most 20 subscriptions, so this transfer will fail if the target user already has 20 subscriptions.

NOTE: If this deletes the final subscription belonging to a user, and the user does not have any aliases, then the entire user will be deleted.


You're Viewing User Model 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 Migration Guide.

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