Create or update one or more user aliases when you already know an existing alias. This API performs an upsert on the user’s identity object—either adding new aliases or updating existing ones.
external_id
, onesignal_id
, or a custom alias) and specifying additional aliases to add or update.
This endpoint focuses solely on the identity
object. If you need to fully create a user with subscriptions and properties, use the Create user API instead.
alias_label
already exists for the user, it will be updated. If it doesn’t exist, a new alias will be created.alias_label
for the type of alias you know (e.g., external_id
, onesignal_id
, or a custom alias)alias_id
for the value of that aliasexternal_id
as your primary user identifier. This can be done through our frontend SDK’s login method when a user signs in to your app or website. It helps OneSignal associate the user’s push, email, and SMS subscriptions to a unified user identity.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
.