v1
latestOpenAPI 3.1.02026-07-246026.9 KBUpdate a User
Update the profile of a user by specifying their userId and platform as query parameters. A 200 response with {"status": "update in progress"} confirms the request was accepted and is being processed asynchronously.
Caution: Read-only fields
The following profile fields can't be updated. Don't include any of these keys in the request body:
- Any key prefixed with aiq or _
- userId, gcmId, mTime, firstUserId, active, display_language, daysActive, identified, permission, sdkVersion, installSource, installType, subscribed, subscription, referrer_timestamp_seconds, referrer, wUserId, uninstallTime
patch/users/
Query parameters
userIdstring required
Example:12345
Required. The AIQUA user ID of the user profile to update. To look up a user's userId, use Retrieve Users. The value is case-sensitive.
platform'android' | 'ios' | 'web' | 'offline' required
Example:web
Required. The platform of the user profile to update. The value is case-sensitive.
Headers
appidstring required
Example:<YOUR_APP_ID>
Required. Your AIQUA app ID.
authorizationstring required
Example:Token <YOUR_API_TOKEN>
Required. Your AIQUA API token. Must start with "Token".
Request body
object required
Example request
{
"consent_date": "2020-08-01",
"consent": "true"
}Response
Success. The update request has been accepted and is being processed asynchronously.
Example response
{
"status": "update in progress"
}