Use this API to attach a new subscription—such as email, SMS, or push notification—to an existing OneSignal user identified by an alias.
alias_label
and alias_id
path parameters define how the user is identified:
external_id
onesignal_id
, or custom aliasestype
: the channel (e.g., Email
, SMS
, iOSPush
)token
: the unique identifier for the channel (e.g., email address, phone number, push token)type
and token
already exist in the app, the subscription will be transferred to the user identified in the path parameters.
Your App API key with prefix Key
. See Keys & IDs.
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The alias name or key to locate the user. Most commonly set as external_id
but can be the onesignal_id
or a custom alias.
The specific identifier for the given alias to identify the user.
200
The response is of type object
.