Developers
API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Key Management

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

Warehouse Sync API Overview

Warehouse Sync API Tutorial

Warehouse Sync API Reference

Data Mapping

Warehouse Sync SQL Reference

Warehouse Sync Troubleshooting Guide

ComposeID

Warehouse Sync API v2 Migration

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

Cordova

Cordova Plugin

Identity

Android

Initialization

Configuration

Network Security Configuration

Event Tracking

User Attributes

IDSync

Screen Events

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

WebView Integration

Logger

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Flutter

Getting Started

Usage

API Reference

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

iOS

Workspace Switching

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

Webview Integration

Upload Frequency

App Extensions

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting iOS SDK

Social Networks

iOS 14 Guide

iOS 15 FAQ

iOS 16 FAQ

iOS 17 FAQ

iOS 18 FAQ

API Reference

Upgrade to Version 7

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Xbox

Getting Started

Identity

Web

Initialization

Configuration

Content Security Policy

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xamarin

Getting Started

Identity

Alexa

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Quickstart
Android

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Step 9. Test your local app

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Tools

Linting Tools

Smartype

mParticle Command Line Interface

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

Glossary

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

Rules Developer Guide

Media SDKs

Android

Web

iOS

API Credential Management

The Developer's Guided Journey to mParticle

Guides
Customer 360

Overview

User Profiles

Overview

User Profiles

Group Identity

Overview

Create and Manage Group Definitions

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictive Attributes

What are predictive attributes?

Predict Future Behavior

Create Future Prediction

Use Future Predictions in Campaigns

Assess and Troubleshoot Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action (NBA)

View and Manage NBAs

Activate Next Best Actions in Campaigns

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
Billing

Usage and Billing Report

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

The New mParticle Experience

The new mParticle Experience

The Overview Map

Platform Settings

Key Management

Event Forwarding

Notification Center (Early Access)

System Alerts

Trends

Introduction

Data Retention

Data Catalog

Connections

Activity

Data Plans

Live Stream

Filters

Rules

Blocked Data Backfill Guide

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Usage metering for value-based pricing (VBP)

Troubleshooting mParticle

Segmentation
New Audiences Experience

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

FAQ

Classic Audiences Experience

Real-time Audiences (Legacy)

Standard Audiences (Legacy)

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

New vs. Classic Experience Comparison

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

IDSync

IDSync Overview

Use Cases for IDSync

Components of IDSync

Store and Organize User Data

Identify Users

Default IDSync Configuration

Profile Conversion Strategy

Profile Link Strategy

Profile Isolation Strategy

Best Match Strategy

Aliasing

Analytics

Introduction

Core Analytics (Beta)

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Analyses

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

Assisted Analysis

Properties Explorer

Frequency in Segmentation

Trends in Segmentation

Did [not] Perform Clauses

Cumulative vs. Non-Cumulative Analysis in Segmentation

Total Count of vs. Users Who Performed

Save Your Segmentation Analysis

Export Results in Segmentation

Explore Users from Segmentation

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

Group By

Filters

Conversion over Time

Conversion Order

Trends

Funnel Direction

Multi-path Funnels

Analyze as Cohort from Funnel

Save a Funnel Analysis

Explore Users from a Funnel

Export Results from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Query Builder

Data Dictionary

Query Builder Overview

Modify Filters With And/Or Clauses

Query-time Sampling

Query Notes

Filter Where Clauses

Event vs. User Properties

Group By Clauses

Annotations

Cross-tool Compatibility

Apply All for Filter Where Clauses

Date Range and Time Settings Overview

User Attributes at Event Time

Understanding the Screen View Event

User Aliasing

Dashboards

Dashboards––Getting Started

Manage Dashboards

Dashboard Filters

Organize Dashboards

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

Analytics Resources

The Demo Environment

Keyboard Shortcuts

User Segments

Tutorials

Analytics for Marketers

Analytics for Product Managers

Compare Conversion Across Acquisition Sources

Analyze Product Feature Usage

Identify Points of User Friction

Time-based Subscription Analysis

Dashboard Tips and Tricks

Understand Product Stickiness

Optimize User Flow with A/B Testing

APIs

User Segments Export API

Dashboard Filter API

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Identity Providers

Single Sign-On (SSO)

Setup Examples

Settings

Debug Console

Data Warehouse Delay Alerting

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

Advanced Data Warehouse Settings

AWS Kinesis (Snowplow)

AWS Redshift (Define Your Own Schema)

AWS S3 Integration (Define Your Own Schema)

AWS S3 (Snowplow Schema)

BigQuery (Snowplow Schema)

BigQuery Firebase Schema

BigQuery (Define Your Own Schema)

GCP BigQuery Export

Snowflake (Snowplow Schema)

Snowplow Schema Overview

Snowflake (Define Your Own Schema)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations
24i

Event

Aarki

Audience

Abakus

Event

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

AdMedia

Audience

Adjust

Event

Feed

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Airship

Audience

Event

Feed

Algolia

Event

AlgoLift

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SQS

Event

Amazon SNS

Event

Amobee

Audience

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Antavo

Feed

Anodot

Event

AppLovin

Audience

Event

Apptimize

Event

Apteligent

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Attentive

Feed

Event

Attractor

Event

Microsoft Azure Blob Storage

Event

Awin

Event

Apptentive

Event

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Batch

Audience

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Button

Audience

Event

Cadent

Audience

ciValue

Event

Feed

Census

Feed

comScore

Event

CleverTap

Audience

Event

Feed

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Custom Feed

Custom Feed

CustomerGlu

Event

Feed

Crossing Minds

Event

Databricks

Data Warehouse

Customer.io

Audience

Feed

Event

Datadog

Event

Didomi

Event

Dynamic Yield

Event

Audience

Dynalyst

Audience

Emarsys

Audience

Edge226

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Fiksu

Event

Audience

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

Formation

Event

Feed

Foursquare

Feed

Audience

ForeSee

Event

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics 4

Event

Google Analytics

Event

Google BigQuery

Audience

Data Warehouse

Google Enhanced Conversions

Event

Google Cloud Storage

Audience

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Google Marketing Platform Offline Conversions

Event

Hightouch

Feed

Herow

Feed

Hyperlocology

Event

Ibotta

Event

ID5

Kit

Impact

Event

InMarket

Audience

Insider

Audience

Event

Feed

Inspectlet

Event

Intercom

Event

InMobi

Audience

Event

iPost

Feed

Audience

ironSource

Audience

Jampp

Event

Audience

Iterable

Event

Audience

Feed

Kayzen

Audience

Event

Kissmetrics

Event

Kafka

Event

Klaviyo

Event

Audience

Kochava

Feed

Event

Forwarding Data Subject Requests

Kubit

Event

Leanplum

Audience

Event

Feed

LifeStreet

Audience

LaunchDarkly

Feed

LinkedIn

LinkedIn Conversions API Integration

Liftoff

Event

Audience

LiveLike

Event

Liveramp

Audience

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Event

Forwarding Data Subject Requests

Moloco

Audience

Event

MoEngage

Audience

Event

Feed

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

myTarget

Audience

Event

Nanigans

Event

Nami ML

Feed

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Oracle Responsys

Audience

Event

PieEye

Inbound Data Subject Requests

Personify XP

Event

Persona.ly

Audience

Pilgrim

Event

Feed

Pinterest

Audience

Event

Plarin

Event

Postie

Event

Audience

Quadratic Labs

Event

Primer

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Rakuten

Event

Regal

Event

Reddit

Audience

Event

Remerge

Audience

Event

Retina AI

Feed

Event

Reveal Mobile

Event

RevenueCat

Feed

Rokt

Audience

Event

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Audience

Event

Feed

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

ShareThis

Audience

Feed

Shopify

Custom Pixel

Feed

Signal

Event

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

SmarterHQ

Event

Snapchat

Event

Audience

Snapchat Conversions

Event

Snowflake

Data Warehouse

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Stormly

Audience

Event

Statsig

Feed

Event

Swrve

Event

Feed

Talon.One

Audience

Feed

Event

Loyalty Feed

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Audience Migration

Event

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Twitter

Event

Audience

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webtrends

Event

Webhook

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Wootric

Event

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

Yotpo

Feed

Z2A Digital

Event

Audience

YouAppi

Audience

Zendesk

Feed

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

Step 7. Track user data

We started this tutorial by creating an input using the Higgs Shop sample app, setting up a webhook output, and creating a connection between the two. We then learned how to collect data about specific events.

If the Higgs Shop were a real app, these events would be triggered by users. Building an understanding of who these users are and how they’re interacting with the app is the final piece of our data puzzle.

We track users with IDSync, mParticle’s identity resolution and management tool. IDSync provides three main benefits:

  • Maintaining data continuity: IDSync ensures that data collected is attributed to the correct user.
  • Cross-device tracking: IDSync tracks users seamlessly between your different applications and platforms, without creating duplicate data.
  • Privacy compliance: When used in tandem with Data Privacy Controls, IDSync makes it easy to comply with privacy requirements.

How does IDSync work?

IDSync accepts requests from the Android SDK to identify the current user of your app. These requests include any available identifiers (either from cookies or the browser’s local storage) that are used to search for a matching user profile in mParticle. If there is a match, then the found profile is attributed with the data collected during the current session. If a match isn’t found, the user remains anonymous and any future events they trigger are attributed to an anonymous profile.

Components of IDSync

There are several components and concepts involved in identity resolution:

  • User Profile: a record of a user’s event data and attributes. Profiles are differentiated in mParticle by a unique mParticle ID.
  • User identifier: an attribute value used to identify a user, like an email address or phone number.
  • Login ID: a subset of user identifiers that are able to uniquely identify a single user.
  • Identity priority: a list of identifiers organized by their ability to confidently identify a user.
  • Identity strategy: a configuration in your account that determines how data should be attributed if a user can or cannot be identified.

Known and anonymous users

All users are considered to be either known or anonymous. A known user has an existing profile containing a login ID. For example, a user who has already created an account using a login ID is considered known.

An anonymous user does not have a profile with a login ID. In other words, a user could have previously used your app, generating data attributed with a profile, but if they didn’t created an account using a login ID they are considered anonymous.

Identifying users

The process of identifying users (a process often referred to as “identity resolution”) involves three steps:

1. The SDK makes an identification request

An identify call is made, passing in any available identifiers. These might be identifiers like a device ID stored within the browser’s local storage or a cookie, or they could be a login ID like an email address or username that the user entered into a login form..

2. IDSync looks for a matching user profile in mParticle

IDSync looks for a matching user profile using the identifiers included with the identification request in order of preference as defined by your identity priority. For example, an email address will return a matching user profile with a higher degree of confidence than a device ID, so email address is usually listed higher in your identity priority.

3. IDSync returns the correct mParticle ID

If a match is found, IDsync returns the corresponding mParticle ID (MPID), the user becomes known, and all previous and following events are associated with this MPID. If a match wasn’t found, the SDK continues to use the original MPID generated for the current user, as per the default identity strategy.

Now that we’re familiar with the concepts of identity resolution, let’s learn how to use the Android SDK to identify and track users in the Higgs Shop sample app.

Using IDSync to track user data

IDsync provides four methods for tracking and managing users:

  • identify: Called automatically when the SDK is initialized.
  • login: Used when a user logs into an account.
  • logout: Used when a user logs out of an account.
  • modify: Used when you need to add or change the identities associated with a profile, such as when a user updates their email address or phone number.

Identify the current user

You can identify a user when initializing the Android SDK by creating an IdentityAPIRequest.

If the user is already logged in or you already have some identifiers for the user, create an identity request using IdentityApiRequest.withEmptyUser() when initializing the Android SDK in the HiggsShopSampleApplication.kt file. Set the identifers for your user using .email() and .customerId(), as in the following example.

Make sure to include import com.mparticle.identity.BaseIdentityTask and import com.mparticle.identity.IdentityApiRequest, otherwise you will not have access to the IDSync API.

package com.mparticle.example.higgsshopsampleapp;

import android.app.Application
import com.mparticle.MParticle
import com.mparticle.MParticleOptions
import com.mparticle.identity.BaseIdentityTask
import com.mparticle.identity.IdentityApiRequest

class HiggsShopSampleApplication: Application() {
    val TAG = "HiggsShopSampleApplication"
    override fun onCreate() {
        super.onCreate()

        val identityRequest = IdentityApiRequest.withEmptyUser()
            .email("janedoe@example.com")
            .customerId("123456")
            .build()

        val identifyTask = BaseIdentityTask()
            .addFailureListener { identityHttpResponse ->
                //handle failure - see below
            }.addSuccessListener { identityApiResult ->
                val user = identityApiResult.user
                user.setUserAttribute("example attribute key", "example attribute value")
            }

        val options: MParticleOptions = MParticleOptions.builder(this)
            .credentials(BuildConfig.HIGGS_SHOP_SAMPLE_APP_KEY, BuildConfig.HIGGS_SHOP_SAMPLE_APP_SECRET)
            .environment(MParticle.Environment.Development)
            // logLevel can be 'NONE', 'ERROR', 'WARNING', 'DEBUG', 'VERBOSE', or 'INFO
            .logLevel(MParticle.LogLevel.VERBOSE)
            .identify(identityRequest)
            .identifyTask(identifyTask)
            .build()

        MParticle.start(options)
    }
}

If you don’t provide any identities in an identityRequest object, then the SDK uses browser local storage based on the most recent user.

You will notice that the Higgs Shop is not configured to handle a failed IDSync request, but the SDK does provide this functionality. Learn more in Error Handling.

Log in a user

You can configure your app to call the login method whenever a user performs the corresponding action in your app. The login method accepts an identity request as shown above, in addition to an optional callback function.

Following is a generic example of the use of the login method to log in a user with a known email address and customer ID:

val identityRequest = IdentityApiRequest.withEmptyUser()
            .email("foo@example.com")
            .customerId("123456")
            .build()
MParticle.getInstance().Identity().login(identityRequest)

In the Higgs Shop, login behavior is defined in the file AccountFragment.kt:

binding.accountCta.setOnClickListener {
    when(MParticle.getInstance()?.Identity()?.currentUser?.isLoggedIn) {
        false -> {
            //no user so login
            val identityRequest = IdentityApiRequest.withEmptyUser()
                .email("higgs@mparticle.com")
                .customerId("higgs123456")
                .build()
            MParticle.getInstance()?.Identity()?.login(identityRequest)?.addSuccessListener {
                accountViewModel.login()
                showIdentityAlert("mParticle Login Call")
            }
        }
        true -> {
            //user exists in sample app so logout
            MParticle.getInstance()?.Identity()?.logout()?.addSuccessListener {
                accountViewModel.logout()
                showIdentityAlert("mParticle Logout Call")
            }
        }
        else -> {}
    }
}

Log out a user

The logout method is very similar to login. You can include any anonymous identifiers you want to associate with the logged-out state of the user. The more common approach is to omit the IdentityApiRequest which results in the logged-out user remaining entirely anonymous, with no associated identifiers.

MParticle.getInstance().Identity().logout()

// exluding the identity request from any IDSync API is the same as invoking the following:
MParticle.getInstance().Identity().logout(IdentityApiRequest.withEmptyUser().build())

In the Higgs Shop, log out behavior is handled in the same file as the login behavior, AccountFragment.kt:

binding.accountCta.setOnClickListener {
    when(MParticle.getInstance()?.Identity()?.currentUser?.isLoggedIn) {
        false -> {
            //no user so login
            val identityRequest = IdentityApiRequest.withEmptyUser()
                .email("higgs@mparticle.com")
                .customerId("higgs123456")
                .build()
            MParticle.getInstance()?.Identity()?.login(identityRequest)?.addSuccessListener {
                accountViewModel.login()
                showIdentityAlert("mParticle Login Call")
            }
        }
        true -> {
            //user exists in sample app so logout
            MParticle.getInstance()?.Identity()?.logout()?.addSuccessListener {
                accountViewModel.logout()
                showIdentityAlert("mParticle Logout Call")
            }
        }
        else -> {}
    }
}

Modify a user profile

To modify a user’s profile, the same IdentifyApiRequest.withEmptyUser() method is called.

When you make a modify request, the Android SDK assigns the current user’s MPID to the request if you don’t supply a user when creating the request object.

In the following example, the SDK would either update the existing email address associated with the user or add the email address if one didn’t already exist.

IdentityApiRequest modifyRequest = IdentityApiRequest.withEmptyUser()
        .email("updated-email@example.com")
        .build()

MParticle.getInstance().Identity().modify(modifyRequest)

<< Previous Next >> Data Planning

Was this page helpful?

    Last Updated: June 19, 2025