v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

Create or update alias

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.

patch/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

alias_labelstring required

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.

alias_idstring required

The specific identifier for the given alias to identify the user.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Request body

Response

200

Example response

{
  "identity": {
    "onesignal_id": "OneSignal-ID-in-UUID-v4-format",
    "custom_alias_label": "the-users-custom-alias-id"
  }
}