Transfer subscription
Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity.
PATCH
Overview
Use this API to transfer a Subscription from one user to another within the same OneSignal app.
This is typically used when:
- You want to reassign an existing push, email, or SMS Subscription to a new or updated user.
- You have changed how you’re identifying users (e.g., migrating from anonymous to known users).
- Subscriptions cannot be transferred across different OneSignal apps.
- For email and SMS Subscriptions, you can instead create new ones using Create User.
- For push Subscriptions, platform limitations may apply—see Subscriptions for details.
How to Use This API
Required Path Parameter: subscription_id
You must know the subscription_id of the subscription to be transferred. This is a unique UUID assigned by OneSignal.
Required Body Parameter: identity (object)
This specifies the user the subscription should be moved to. Only one alias should be used per request. You can identify the target user using one of:
external_id(recommended)onesignal_id- A custom alias
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The unique Subscription ID in UUID v4 format to transfer to the new user.
Body
application/json
Response
200
application/json
200
The response is of type object.