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

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

Cordova

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

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

Roku

Getting Started

Identity

Media

React Native

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

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

Xamarin

Getting Started

Identity

Alexa

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

iOS

Web

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

mParticle Command Line Interface

Linting Tools

Smartype

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

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

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

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

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

The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

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

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

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

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

AWS Kinesis (Snowplow)

Advanced Data Warehouse Settings

AWS Redshift (Define Your Own Schema)

AWS S3 (Snowplow Schema)

AWS S3 Integration (Define Your Own 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

Abakus

Event

Aarki

Audience

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

Adjust

Event

Feed

AdMedia

Audience

Adobe Audience Manager

Audience

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Target

Audience

Adobe Campaign Manager

Audience

AdPredictive

Feed

AgilOne

Event

Algolia

Event

Airship

Audience

Feed

Event

AlgoLift

Event

Feed

Amazon Advertising

Audience

Amazon Kinesis

Event

Alooma

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SQS

Event

Amazon SNS

Event

Amplitude

Forwarding Data Subject Requests

Event

Amobee

Audience

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

Antavo

Feed

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

AppLovin

Audience

Event

Apptentive

Event

Attentive

Event

Feed

Apteligent

Event

Apptimize

Event

Attractor

Event

Microsoft Azure Blob Storage

Event

Awin

Event

Bidease

Audience

Batch

Audience

Event

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Branch

Event

Feed

Forwarding Data Subject Requests

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Cadent

Audience

ciValue

Event

Feed

Button

Audience

Event

CleverTap

Audience

Event

Feed

Census

Feed

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Crossing Minds

Event

CustomerGlu

Event

Feed

Custom Feed

Custom Feed

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Event

Audience

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Fiksu

Audience

Event

Google Analytics for Firebase

Event

Flurry

Event

Flybits

Event

ForeSee

Event

Formation

Feed

Event

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Analytics

Event

Google Ads

Audience

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Ibotta

Event

Google Tag Manager

Event

ID5

Kit

Impact

Event

InMarket

Audience

InMobi

Audience

Event

Insider

Audience

Feed

Event

Intercom

Event

iPost

Audience

Feed

Inspectlet

Event

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Audience

Event

Kissmetrics

Event

Klaviyo

Audience

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Feed

Event

LifeStreet

Audience

LinkedIn

LinkedIn Conversions API Integration

Liftoff

Audience

Event

LiveLike

Event

Localytics

Event

Liveramp

Audience

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Event

Audience

Forwarding Data Subject Requests

Mintegral

Audience

MoEngage

Event

Audience

Feed

Moloco

Audience

Event

Monetate

Event

Movable Ink

Event

Movable Ink - V2

Event

Multiplied

Event

Nami ML

Feed

myTarget

Event

Audience

Nanigans

Event

Narrative

Audience

Event

Feed

NCR Aloha

Event

Neura

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

Paytronix

Feed

Persona.ly

Audience

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Personify XP

Event

Plarin

Event

Pinterest

Audience

Event

Postie

Audience

Event

Primer

Event

Anodot

Event

Qualtrics

Event

Quantcast

Event

Quadratic Labs

Event

Radar

Feed

Event

Rakuten

Event

Reddit

Event

Audience

Regal

Event

Remerge

Audience

Event

Retina AI

Event

Feed

RevenueCat

Feed

Reveal Mobile

Event

Rokt

Audience

Event

RTB House

Audience

Event

Salesforce Email

Event

Feed

Audience

Sailthru

Audience

Event

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

Audience

Event

Snapchat Conversions

Event

Snowflake

Data Warehouse

Split

Event

Feed

Snowplow

Event

Splunk MINT

Event

Sprig

Audience

Event

StartApp

Audience

Statsig

Event

Feed

Swrve

Event

Feed

Stormly

Audience

Event

Talon.One

Audience

Event

Loyalty Feed

Feed

Tapad

Audience

Taplytics

Event

Taptica

Audience

Tapjoy

Audience

Teak

Audience

The Trade Desk

Cookie Sync

Audience

Event

TikTok Event

Audience

Event

Audience Migration

Audience (Deprecated)

Ticketure

Feed

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Valid

Event

Vkontakte

Audience

Twitter

Audience

Event

Voucherify

Event

Audience

Webhook

Event

Webtrends

Event

Wootric

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Vungle

Audience

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

IDSync

The SDK surfaces a series of APIs to manage user-identity state. These client-side APIs work in tandem with the mParticle IDSync HTTP API and your configured “identity strategy.” These APIs are designed generically but identity management requirements vary by app - so it’s crucial that you use the APIs correctly per your app’s unique requirements.

See the mParticle IDSync overview for a platform-agnostic overview of the key operations you can perform and read below for how the API is surfaced in the Android SDK.

Overview

There are four key APIs exposed via the Android SDK:

  • “identify”
  • “login”
  • “logout”
  • “modify”

The following applies to all of these APIs:

  • All APIs are asynchronous
  • All APIs accept the same IdentityApiRequest object type
  • All APIs return a MParticleTask<IdentityApiResult> to listen for success and failure
  • All APIs follow the same user-transition paradigm: the identity request dictates the details of the user you would like to transition the SDK to, not the user you are transitioning from. The SDK maintains a “current” user, to which all events are attributed until the current user changes.
  • Every time they are invoked, the SDK will immediately upload an HTTP request. Because of this, these APIs must only be invoked when the user actually logs in, logs out, or otherwise changes state. A common mistake is to call an API such as identify or login on every app startup - this is not necessary and will result in high network traffic.

Create an IDSync Request

Populating IDSync requests correctly is crucial to managing the state of your users and the association of events. Reference the complete API reference for specific Android API and parameter-level details.

An IdentityApiRequest is a holder for a set of identities that you would like to associate with the user. The IdentityApiRequest provides two static factory methods that return the IdentityApiRequest.Builder used to construct the request:

  • IdentityApiRequest.withEmptyUser() - this will result in an empty user/request
  • IdentityApiRequest.withUser(user) - this will result in a request containing the same identities as the given user, which you can then mutate further
IdentityApiRequest identityRequest = IdentityApiRequest.withEmptyUser()
    //the IdentityApiRequest provides several convenience methods for common identity types
    .email("foo@example.com")
    .customerId("123456")
    //alternatively, you can use the setUserIdentity method and supply the MPUserIdentity type
    .userIdentity(MParticle.IdentityType.Other, "example-other-id")
    .build();
val identityRequest = IdentityApiRequest.withEmptyUser().run {
    //the IdentityApiRequest provide convenience methods for common identity types
    email("foo@example.com")
    customerId("123456")
    //alternatively, you can use the setUserIdentity method and supply the MPUserIdentity type
    userIdentity(MParticle.IdentityType.Other, "example-other-id")
    build()
}

When you invoke any of the four key IDSync APIs with an IdentityApiRequest:

  • The SDK will verify the contents of the API request, resulting in a potential runtime warning or error
  • The SDK will automatically append device identities such as the Android Advertising ID to the IDSync request
  • The SDK will invoke the requested IDSync operation with all of the supplied identities
  • The IDSync HTTP API will respond with a matching MPID. The SDK will automatically switch to this MPID and all future events will be associated with that MPID.

SDK Initialization and Identify

The “identify” API is unique in that it is called automatically on SDK initialization by the mParticle SDK. The SDK requires this call to succeed in order to establish an mParticle ID to associate with all data.

There are several considerations to account for during SDK initialization:

  • If the user is already logged in during initialization of your app (from a previous session), or you otherwise have identifying information about the user that you would like to supply, you should create an IdentityApiRequest and set it to the identify field of your MParticleOptions object, and supply that to mParticle’s start API. See the SDK initialization example below.
  • If you do not provide an IdentityApiRequest during SDK initialization, the mParticle SDK will use its local persistence to generate a IdentityApiRequest for you based off of the most recent user, supplying the most recent user identities.
  • If this is a new app-install, and the identify call fails, you should retry the request. See below for information on reacting to failed IDSync API requests.

Here’s an example of how you might initialize the SDK and set a user-attribute once the user object becomes available:

public class ExampleApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        IdentityApiRequest identityRequest = IdentityApiRequest.withEmptyUser()
                .email("foo@example.com")
                .customerId("123456")
                .build();

        BaseIdentityTask identifyTask = new BaseIdentityTask()
                .addFailureListener(new TaskFailureListener() {
                    @Override
                    public void onFailure(IdentityHttpResponse identityHttpResponse) {
                        //handle failure - see below
                    }
                }).addSuccessListener(new TaskSuccessListener() {
                    @Override
                    public void onSuccess(IdentityApiResult identityApiResult) {
                        MParticleUser user = identityApiResult.getUser();
                        user.setUserAttribute("example attribute key", "example attribute value");
                    }
                });

        MParticleOptions options = MParticleOptions.builder(this)
                .credentials("REPLACE WITH API KEY", "REPLACE WITH API SECRET")
                .identify(identityRequest)
                .identifyTask(identifyTask)
                .build();
        MParticle.start(options);
    }
}
class ExampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        val identityRequest = IdentityApiRequest.withEmptyUser()
            .email("foo@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.builder(this)
            .credentials("REPLACE WITH API KEY", "REPLACE WITH API SECRET")
            .identify(identityRequest)
            .identifyTask(identifyTask)
            .build()
        MParticle.start(options)
    }
}

Login and Logout

The login and logout APIs should be invoked at the time of the user performing the matching actions in your application. These methods have identical signatures - they both accept an IdentityApiRequest and return an MParticleTask<IdentityApiResult> that allows you to listen for both success and failure:

// Define your identityRequest
IdentityApiRequest identityRequest = IdentityApiRequest.withEmptyUser()
    // Include any identities you want to associate with the logged in user here. See "Create an IDSync request" above for more details.
    // This example shows the addition of the email identity.
    .email("foo@example.com").build();

// Call the login method, passing in the identityRequest you just created
MParticle.getInstance().Identity().login(identityRequest);
// Define your identityRequest
val identityRequest = IdentityApiRequest.withEmptyUser()
    // Include any identities you want to associate with the logged in user here. See "Create an IDSync request" above for more details.
    // This example shows the addition of the email identity.
    .email("foo@example.com").build()

// Call the login method, passing in the identityRequest you just created
MParticle.getInstance().Identity().login(identityRequest)

Logout is invoked similarly to login, and you can supply an IdentityApiRequest if you have anonymous identifiers you would like to associate with the logged-out user state. More commonly, you can exclude the IdentityApiRequest to denote that the logged-out user should have no associated user identities:

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());
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())

Modify

Modify also has the identical signature, but note a crucial difference: modify actions are always for a specific mParticle ID (MPID) - they will never result in a new user or MPID. Modify can only add, remove, or change the identities associated with an existing user. Please note that this should not be used to handle registration/login and logout scenarios. Modify is generally used when a user updates their profile in their app, such as updating their email.

For each modify request:

  • the SDK will assign the current user’s mParticle ID (MPID) to the request if you did not supply a user while creating the request object
  • the SDK will calculate a delta between the given MPID’s known user identities, stored on the current device, with those that you supply within the IdentityApiRequest, and invoke the underlying Identity HTTP API

In this example, the SDK will change the email of the current user, or add the email to the user’s profile if the user has no existing email on this device:

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

MParticle.getInstance().Identity().modify(modifyRequest);
IdentityApiRequest modifyRequest = IdentityApiRequest.withEmptyUser()
        .email("updated-email@example.com")
        .build()

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

In this example, the SDK will remove the email of the current user, or will do nothing if the user has no email on this device:

IdentityApiRequest modifyRequest = IdentityApiRequest.withEmptyUser()
        .email(null)
        .build();

MParticle.getInstance().Identity().modify(modifyRequest);
val modifyRequest = IdentityApiRequest.withEmptyUser()
        .email(null)
        .build()

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

Handle Success and Failure

The mParticle IDSync API is intended to be central to your app’s state and is designed to be fast and highly-available. Similar to how your app may prevent users from logging in, logging out, or modifying their state without an internet connection - we intend you to treat these APIs as gating operations in order to maintain a consistent user state. The SDK will not retry API calls automatically, but provides callback APIs such that you can do so according to your business logic. The tolerance you have for retry and inconsistent state is up to your product requirements.

IDSync Status Codes

The SDK will always return the HTTP status and HTTP body of the underlying HTTP response. The SDK will return IdentityApi.UNKNOWN_ERROR as well as an informative error message for client-side issues including:

  • Device out of coverage or client-side timeout
  • Invalid identity requests
  • Performing a modify request prior to the first successful identify request

For more information about 429 responses and API throttling, see Default Service Limits.

MParticle.getInstance().Identity().login(identityRequest)
    .addFailureListener(new TaskFailureListener() {
        @Override
        public void onFailure(IdentityHttpResponse identityHttpResponse) {
            if (identityHttpResponse.getHttpCode() == IdentityApi.UNKNOWN_ERROR) {
                //device is likely offline and request should be retried
            } else if (identityHttpResponse.getHttpCode() == IdentityApi.THROTTLE_ERROR) {
               //on rare occurances you may receive and retry throttling errors (429)
            }
            Log.d("IDSync Error", identityHttpResponse.toString());
        }
    })
    .addSuccessListener(new TaskSuccessListener() {
        @Override
        public void onSuccess(IdentityApiResult identityApiResult) {
            //proceed with login
        }
    });
MParticle.getInstance().Identity().login(identityRequest)
    .addFailureListener { identityHttpResponse ->
        if (identityHttpResponse.httpCode == IdentityApi.UNKNOWN_ERROR) {
            //device is likely offline and request should be retried
        } else if (identityHttpResponse.httpCode == IdentityApi.THROTTLE_ERROR) {
            //on rare occurances you may receive and retry throttling errors (429)
        }
        Log.d("IDSync Error", identityHttpResponse.toString())
    }
    .addSuccessListener {
        //proceed with login
    }

User Aliasing

As mentioned in the overview above, the IDSync API is meant to transition the SDK’s “current user.” The SDK maintains values in persistence that are associated with each user, such as user attributes. On completion of a successful login, you can copy user data from the previous user to the new user.

If your organization uses Profile Link or Profile Conversion strategies, you can also create a request to alias the previous user to the current user. See our main documentation on aliasing for more information.

// Basic - Call alias as the result of a successful login
MParticle.getInstance().Identity().login()
    .addSuccessListener(new TaskSuccessListener() {
        @Override
        public void onSuccess(@NonNull IdentityApiResult result) {
            login request returns new and previous users
            MParticleUser newUser = result.getUser();
            MParticleUser previousUser = result.getPreviousUser();
            
            // Copy anything attributes and products from previous to new user
            // this example copies everything
            newUser.setUserAttributes(previousUser.getUserAttributes());

            // Create and send the alias request
            AliasRequest request = AliasRequest
                    .builder(previousUser, newUser)
                    .build();
            MParticle.getInstance().Identity().aliasUsers(request);
        }
    });

// Call alias at any time 

// The getUsers() API now returns users in reverse chronological order
MParticleUser sourceUser = MParticle.getInstance().Identity().getUsers().get(1);
MParticleUser destinationUser = MParticle.getInstance().Identity().getUsers().get(0);

AliasRequest request = AliasRequest.builder()
    .sourceMpid(sourceUser.getId())
    .destinationMpid(destinationUser.getId())
    .startTime(sourceUser.getFirstSeenTime()) // must be within 90 days
    .endTime(sourceUser.getLastSeenTime()) // must be between StartTime and now
    .build();
MParticle.getInstance().Identity().aliasUsers(request);
// Basic - Call alias as the result of a successful login
MParticle.getInstance()?.Identity()?.login()?.addSuccessListener {
    result ->
    // login request returns new and previous users
    val newUser: MParticleUser = result.getUser()
    val previousUser: MParticleUser? = result.getPreviousUser()

    // Copy any attributes from previous to new user
    // this example copies everything
    previousUser?.let { newUser.setUserAttributes(it.userAttributes) }

    // Create and send the alias request
    val request: AliasRequest = AliasRequest.Builder()
        .sourceMpid(previousUser?.id ?: 0)
        .destinationMpid(newUser.id)
        .build();
    MParticle.getInstance()?.Identity()?.aliasUsers(request);
}

// Call alias at any time

// The getUsers() API now returns users in reverse chronological order
val sourceUser: MParticleUser? = MParticle.getInstance()?.Identity()?.users?.get(1)
val destinationUser: MParticleUser? = MParticle.getInstance()?.Identity()?.users?.get(0)

if(sourceUser != null && destinationUser != null) {
    val request: AliasRequest = AliasRequest.Builder()
        .sourceMpid(sourceUser?.id)
        .destinationMpid(destinationUser?.id)
        .startTime(sourceUser.firstSeenTime) // must be within 90 days
        .endTime(sourceUser.lastSeenTime) // must be between startTime and now
        .build()
    MParticle.getInstance()?.Identity()?.aliasUsers(request)
}

Listen for IDSync transitions

  • Register for the IdentityStateListener notifications. This will be fired whenever the MPID changes.
IdentityStateListener listener = new IdentityStateListener() {
    @Override
    public void onUserIdentified(@NonNull MParticleUser user, @Nullable previousUser) {
        //
    }
};
MParticle.getInstance().Identity().addIdentityStateListener(listener);
MParticle.getInstance()?.Identity()?.addIdentityStateListener { user, previousUser ->
            
}

In order to stop receiving notifications, you can remove the listener

MParticle.getInstance().Identity().removeIdentityStateListener(listener);
val listener = { user: MParticleUser -> }
MParticle.getInstance()?.Identity()?.removeIdentityStateListener(listener)

Supported Identity Types

See the table below and the complete API reference for supported user identity types:

IdentityType Description
CustomerId If you have an internal ID for your customer
Email The user’s email address
Other Any other identifier that can contribute to user identification
Other2 Any other identifier that can contribute to user identification
Other3 Any other identifier that can contribute to user identification
Other4 Any other identifier that can contribute to user identification
Other5 Any other identifier that can contribute to user identification
Other6 Any other identifier that can contribute to user identification
Other8 Any other identifier that can contribute to user identification
Other8 Any other identifier that can contribute to user identification
Other9 Any other identifier that can contribute to user identification
Other10 Any other identifier that can contribute to user identification
MobileNumber The user’s mobile number
PhoneNumber2 Any other phone number for the user
PhoneNumber3 Any other phone number for the user
FacebookCustomAudienceId The user’s Facebook App User ID that can be retrieved through the Facebook SDK
Google The user’s Google ID
Twitter The user’s Twitter ID
Microsoft The user’s Microsoft ID
Yahoo The user’s Yahoo ID

Was this page helpful?

    Last Updated: June 13, 2025