> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Track User Attributes

> Track user attributes and set unique identifiers for user identification in the MoEngage Android SDK.

User Attributes are pieces of information you know about a user. They could be demographics like age or gender, account-specific like plan, or whether a user has seen a particular A/B test variation. User attributes are a customer identity you can reference throughout the customer’s lifetime.

# Identifying Users

For SDK versions below 13.6.00 refer to [this document](https://www.moengage.com/docs/developer-guide/android-sdk/data-tracking/basic/setting-unique-id-for-sdk-versions-below-13-6-00).

Setting identifiers is important to:

* To tie user behavior across platforms, i.e., iOS, Android, Web, etc.
* This is to ensure unnecessary or stale users are not created.
* To identify users across installs/re-installs.

## Single Identifier

Call the API below to pass the identifier on to the MoEngage SDK.

```kotlin Kotlin wrap theme={null}
MoEAnalyticsHelper.identifyUser(context, "identifier")
```

```java Java theme={null}
MoEAnalyticsHelper.INSTANCE.identifyUser(context, "identifier");
```

*Note*: This method is a replacement for the deprecated ***setUniqueId()***. If you are using ***setUniqueId()*** in your application, consider replacing it with ***identifyUser()***

## Multiple Identifiers

If your application has multiple identifiers using which you identify a user you can pass all the identifiers to the SDK using the below API

```kotlin Kotlin wrap theme={null}
MoEAnalyticsHelper.identifyUser(
    context,
    mapOf("identifierName1" to "identifierValue1", "identifierName2" to "identifierValue2")
)
```

```java Java theme={null}
Map<String, String> identifiers = new HashMap<String, String>() {{
    put("identifierName1", "identifierValue1");
    put("identifierName2", "identifierValue2");
}};
MoEAnalyticsHelper.INSTANCE.identifyUser(context, identifiers);
```

> [!NOTE]
>
> **Updates to SDK functions for User Identification and Session Management**
>
> * **Forced Logout:** The MoEngage SDK no longer automatically logs out the previous user when a new user is detected on the device. Logout should now be explicitly called for workspaces enabled with Identity resolution to avoid data corruption.
> * **SetUniqueID:** `identifyUser` function supports multiple identifiers, which replaces the need of using `SetUniqueID` function for user identification. Note that `SetUniqueID` is marked for removal in the future releases of SDK versions - it is important to use `identifyUser` instead especially if you are using Identity resolution in your workspace.
> * **SetAlias:** For workspaces with the Identity resolution feature enabled, MoEngage SDK stores the previous identifier values. When `identifyUser` function is used to track the new identifier values, MoEngage SDK detects the change in identifier value and reports accordingly.
>
> If you call the `identifyUser` function without logging out, then the existing logged-in user's ID is updated.

If you call `identifyUser()` multiple times with different identifier names, the SDK will append this identifier to the already set identifiers.

Refer to our help [document](https://moengage.com/docs/user-guide/data/user-data/unified-identity-identity-resolution.md) to learn more about the feature.

> [!NOTE]
>
> If a network issue prevents the identifier from reaching the MoEngage server, the SDK caches the `identifyUser()` call and retries automatically once the network is available or the next time the app opens.

For more information, refer to:

* [Enable/Disable SDK](https://moengage.com/docs/developer-guide/android-sdk/compliance/compliance.md#enabledisable-sdk)
* [Enable/Disable Data Tracking](https://moengage.com/docs/developer-guide/android-sdk/compliance/compliance.md#enabledisable-data-tracking)

## Logout

The application needs to notify the MoEngage SDK whenever the user is logged out of the application. Call the API whenever the user is logged out of the application to notify the SDK.

```kotlin Kotlin wrap theme={null}
MoECoreHelper.logoutUser(context)
```

```java Java theme={null}
MoECoreHelper.INSTANCE.logoutUser(context);
```

Logout clears the user's attributes and identities, then starts a new anonymous user with a new session. The SDK retains the device identifier and push token, so logout does not unregister the device for push.

If the application is registering for a push token, it should pass the new push token to MoEngage SDK after the user logs out. For more information about passing push tokens, refer to [Push Configuration for Android SDK](https://moengage.com/docs/developer-guide/android-sdk/push/basic/push-configuration.md).

### Logout Callback

To receive a callback when logout completes, implement [`OnLogoutCompleteListener`](https://moengage.github.io/android-api-reference/core/com.moengage.core.listeners/-on-logout-complete-listener/index.html) and register it using [`MoECoreHelper.addLogoutCompleteListener()`](https://moengage.github.io/android-api-reference/core/com.moengage.core/-mo-e-core-helper/add-logout-complete-listener.html).

The callback is invoked on the main thread and receives a [`LogoutData`](https://moengage.github.io/android-api-reference/core/com.moengage.core.model/-logout-data/index.html) instance. Register the listener in the `onCreate()` of your `Application` class so that no callback is missed. The SDK holds a strong reference to the listener, so do not implement it in an `Activity` or a `Fragment` — doing so leaks that component. To stop receiving callbacks, unregister the same listener instance using [`MoECoreHelper.removeLogoutListener()`](https://moengage.github.io/android-api-reference/core/com.moengage.core/-mo-e-core-helper/remove-logout-listener.html).

```kotlin Kotlin wrap theme={null}
MoECoreHelper.addLogoutCompleteListener { logoutData ->
    // Process your logout completion here, for example, identify the next user
    // or navigate to the login screen.
}
```

```java Java theme={null}
MoECoreHelper.INSTANCE.addLogoutCompleteListener(logoutData -> {
    // Process your logout completion here, for example, identify the next user
    // or navigate to the login screen.
});
```

# Tracking User Attributes

The SDK provides APIs to track commonly tracked user attributes like First Name, Last Name, Email-Id, etc. Please use the provided methods for tracking these attributes.

For more information on supported data types and data tracking policies, please refer to [Data Tracking Policies](https://www.moengage.com/docs/user-guide/data/key-concepts/data-tracking-policies).

```kotlin Kotlin wrap theme={null}
MoEAnalyticsHelper.setFirstName(context, "Jane")
MoEAnalyticsHelper.setLastName(context, "Doe")
MoEAnalyticsHelper.setUserName(context, "jane.doe")
MoEAnalyticsHelper.setLocation(context, GeoLocation(40.77, 73.98))
MoEAnalyticsHelper.setGender(context, UserGender.FEMALE)
MoEAnalyticsHelper.setMobileNumber(context, "+10000000000")
MoEAnalyticsHelper.setBirthDate(context, "1990-01-01T00:00:00.000Z")
MoEAnalyticsHelper.setEmailId(context, "jane.doe@example.com")
```

```java Java theme={null}
MoEAnalyticsHelper.INSTANCE.setFirstName(context, "Jane");
MoEAnalyticsHelper.INSTANCE.setLastName(context, "Doe");
MoEAnalyticsHelper.INSTANCE.setUserName(context, "jane.doe");
MoEAnalyticsHelper.INSTANCE.setLocation(context, new GeoLocation(40.77, 73.98));
MoEAnalyticsHelper.INSTANCE.setGender(context, UserGender.FEMALE);
MoEAnalyticsHelper.INSTANCE.setMobileNumber(context, "+10000000000");
MoEAnalyticsHelper.INSTANCE.setBirthDate(context, "1990-01-01T00:00:00.000Z");
MoEAnalyticsHelper.INSTANCE.setEmailId(context, "jane.doe@example.com");
```

For setting other User Attributes, use the generic method `setUserAttribute(key, value)`. The method accepts the following value types: `String`, `int`, `long`, `float`, `double`, `boolean`, `Date`, `GeoLocation`, `JSONObject`, `JSONArray`, and arrays of `int`, `long`, `float`, `double`, and `String`.

```kotlin Kotlin wrap theme={null}
// Tracking a String Attribute
MoEAnalyticsHelper.setUserAttribute(context,"locality", "SF")
// Tracking a Date Attribute
MoEAnalyticsHelper.setUserAttribute(context,"signedUpOn", Date())
// Tracking a location attribute
MoEAnalyticsHelper.setUserAttribute(context,"lastLocation", GeoLocation(40.77, 73.98))
// Tracking Array Attributes
MoEAnalyticsHelper.setUserAttribute(context,"int_array",arrayOf<Int>(1,2,3))
MoEAnalyticsHelper.setUserAttribute(context,"string_array",arrayOf<String>("English","French"))
MoEAnalyticsHelper.setUserAttribute(context,"double_array",arrayOf<Double>(40.0,20.0))
MoEAnalyticsHelper.setUserAttribute(context,"json_array", JSONArray(listOf(1, 2, 3)))      
MoEAnalyticsHelper.setUserAttribute(context,"json_object", JSONObject().put("key", "value"))
```

```java Java theme={null}
// Tracking a String Attribute
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"locality", "SF");
// Tracking a Date Attribute
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context, "signedUpOn", new Date());
// Tracking a location attribute
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"lastLocation", new GeoLocation(40.77, 73.98));
// Tracking Array Attributes    
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"int_array",new int[]{1,2,3});
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"string_array",new String[]{"English","French"});
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"double_array",new double[]{1.5,2.5});
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"json_array", new JSONArray());
MoEAnalyticsHelper.INSTANCE.setUserAttribute(context,"json_object", new JSONObject());
```

For more information about the detailed list of user attributes, refer to the [API reference](https://moengage.github.io/android-api-reference/core/com.moengage.core.analytics/-mo-e-analytics-helper/index.html).

## Reserved keywords for User Attributes

Below is the list of keys that should not be used when tracking user attributes.

* `USER_ATTRIBUTE_UNIQUE_ID`
* `USER_ATTRIBUTE_USER_EMAIL`
* `USER_ATTRIBUTE_USER_MOBILE`
* `USER_ATTRIBUTE_USER_NAME`
* `USER_ATTRIBUTE_USER_GENDER`
* `USER_ATTRIBUTE_USER_FIRST_NAME`
* `USER_ATTRIBUTE_USER_LAST_NAME`
* `USER_ATTRIBUTE_USER_BDAY`
* `USER_ATTRIBUTE_NOTIFICATION_PREF`
* `USER_ATTRIBUTE_OLD_ID`
* `MOE_TIME_FORMAT`
* `MOE_TIME_TIMEZONE`
* `USER_ATTRIBUTE_DND_START_TIME`
* `USER_ATTRIBUTE_DND_END_TIME`
* `MOE_GAID`
* `INSTALL`
* `UPDATE`
* `MOE_ISLAT`
* `status`
* `user_id`
* `source`

> [!NOTE]
>
> You cannot use "moe\_" as a prefix while naming events, event attributes, or user attributes. It is a system prefix and using it might result in periodic blacklisting without prior communication.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.