v1
latestOpenAPI 3.1.02026-07-26497885.9 KBUpdate user
Modify a user's properties.
patch/apps/{app_id}/users/by/{alias_label}/{alias_id}
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.
onesignal-subscription-idstring
Optional. Identifies a specific subscription to update. Some user properties, such as Session Time and Session Count, will update values on both the User and the Subscription.
Request body
Response
202
Example response
{
"properties": {
"language": "en",
"timezone_id": "PST",
"lat": 90,
"long": 135,
"country": "US",
"first_active": 1678215680,
"last_active": 1678215682,
"test_user_name": "QA Device - Jane",
"purchases": [
{
"amount": "$33.33",
"count": 3,
"iso": "USD",
"sku": "item"
}
]
}
}