Developers
API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

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

Platform API

Key Management

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Audit Logs API

Bulk Profile Deletion API Reference

Custom Access Roles API

Calculated Attributes Seeding API

Data Planning API

Household Reach API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
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

Workspace Switching

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Upgrade to Version 6

AMP

AMP SDK

Cordova

Cordova Plugin

Identity

Upgrade to Version 5

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

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

Upgrade to Version 9

.NET MAUI

Getting Started

Identity

React Native

Getting Started

Identity

Upgrade to Version 4

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

Roku

Getting Started

Identity

Media

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 3 of the SDK

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

Glossary

Data Hosting Locations

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

Tools

mParticle Command Line Interface

Smartype

Linting Tools

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

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

API Credential Management

The Developer's Guided Journey to mParticle

Guides
Platform Overview

Introduction

Navigating mParticle

The Overview Map

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

mParticle Agent

Overview

Explore Your Data

Build Audiences

Create Predictions

Data and Privacy

mParticle Agent FAQ

Oversight

System Alerts

Observability

Observability Overview

Observability User Guide

Observability Troubleshooting Examples

Observability Span Glossary

Privacy

Data Subject Requests

Consent Filters

Data Privacy Controls

Data Platform

Trends

Setup

Connections

Feeds

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

SFTP Credentials

Live Stream

Data Catalog

Rules

Plans

Filters

Event Forwarding

Event Match Quality

Data Retention

Tiered Events

Blocked Data Backfill Guide

Data Warehouse
Composable Audiences

Warehouse Setup Overview

Connections

Connections Overview

Google BigQuery

Databricks

Amazon Redshift

Snowflake

Data Models

Data Models Overview

Create a User Data Model

Create an Event Data Model

Create a Generic Data Model

Warehouse Sync

Warehouse Sync User Guide

Historical Data and Warehouse Sync

Customer 360

Overview

User Profiles

Overview

User Profiles

Identity Dashboard

Identity Resolution Log

Household Reach

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Predictions

Predictions Overview

What's Changed in the New Predictions UI

View and Manage Predictions

Predict Future Behavior

Future Behavior Predictions Overview

Create Future Behavior Prediction

Manage Future Behavior Predictions

Create an Audience with Future Behavior Predictions

Next Best Action

Next Best Action Overview

Create a Next Best Action Prediction

Manage Next Best Actions

Create an Audience with Next Best Actions

Find Similar Customers

Similar Customer Predictions Overview

Create Similar Customer Prediction

Manage Similar Customer Predictions

Build an Audience with Similar Customer Predictions

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

Probabilistic Identity Resolution

Overview

Real-Time Personalization

Analytics

Introduction

Core Analytics (Beta)

Analytics Free Trial

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

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

Audiences

Audiences Overview

Create an Audience

Connect an Audience

Manage Audiences

Audience Insights

Audience Sharing

Match Boost

Inclusive & Exclusive Audiences (Early Access)

Inclusive & Exclusive Audiences Overview

Using Logic Blocks in Audiences

Combining Inclusive and Exclusive Audiences

Inclusive & Exclusive Audiences FAQ

Audience Expansion

Probabilistic Reach

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Composable Audiences

Composable Audiences Overview

User Guide

User Guide Overview

Audience Setup

Frequently Asked Questions

Settings
Platform

Platform Configuration

mParticle Users and Roles

Key Management

Notifications

Audit Logs

Billing

Usage and Billing Report

Usage metering for value-based pricing (VBP)

Troubleshooting mParticle

Default Service Limits

Glossary

Integrations
Aarki

Audience

24i

Event

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adjust

Event

Feed

Adikteev

Audience

Event

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Platform SDK Events

Server-to-Server Events

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

Adobe Experience Platform

Event

AdPredictive

Feed

Airship

Audience

Event

Feed

AgilOne

Event

Algolia

Event

Amazon Kinesis

Event

Amazon Advertising

Audience

Event

Amazon Kinesis Firehose

Audience

Event

Amazon S3

Audience

Event

Amazon Redshift

Data Warehouse

Amazon SNS

Event

Amobee

Audience

Amazon SQS

Event

Amplitude

Event

Forwarding Data Subject Requests

Ampush

Audience

Event

Anodot

Event

Analytics

Event

Forwarding Data Subject Requests

Audience

Antavo

Feed

AppLovin

Audience

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apptimize

Event

Awin

Event

Microsoft Azure Blob Storage

Event

Attentive

Event

Feed

Bidease

Audience

Batch

Audience

Event

Bing Ads

Event

Bluedot

Feed

Bluecore

Event

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Feed

Event

Forwarding Data Subject Requests

Branch S2S Event

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Bugsnag

Event

Census

Feed

Button

Audience

Event

Cadent

Audience

Conversant

Event

CleverTap

Audience

Feed

Event

Cordial

Audience

Feed

comScore

Event

Cortex

Feed

Event

Forwarding Data Subject Requests

Crossing Minds

Event

Custom Feed

Custom Feed

Criteo

Audience

Event

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Datadog

Event

Databricks

Data Warehouse

Didomi

Event

Dynamic Yield

Audience

Event

Eagle Eye

Audience

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Facebook Offline Conversions

Event

Flybits

Event

Google Analytics for Firebase

Event

Flurry

Event

ForeSee

Event

Foursquare

Feed

Audience

FreeWheel Data Suite

Audience

Friendbuy

Event

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Tag Manager

Event

Heap

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Impact

Event

Ibotta

Event

ID5

Kit

Insider

Audience

Event

Feed

InMobi

Audience

Event

InMarket

Audience

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

ironSource

Audience

Jampp

Audience

Event

Iterable

Audience

Event

Feed

Kayzen

Audience

Event

Kafka

Event

Kissmetrics

Event

Klaviyo

Audience

Event

Kochava

Event

Feed

Forwarding Data Subject Requests

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Event

Feed

LifeStreet

Audience

Liftoff

Event

Audience

LinkedIn

Audience

LinkedIn Conversions API Integration

Liveramp

Audience

LiveLike

Event

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Event

Feed

Mautic

Audience

Event

MediaMath

Audience

Marigold

Audience

Mediasmart

Audience

Microsoft Ads

Microsoft Ads Audience Integration

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Event

Mixpanel Cohort Feed Integration

Forwarding Data Subject Requests

Monetate

Event

Moloco

Audience

Event

MoEngage

Audience

Event

Feed

Movable Ink - V2

Event

Multiplied

Event

Movable Ink

Event

myTarget

Audience

Event

Nami ML

Feed

Narrative

Audience

Event

Feed

Nanigans

Event

Neura

Event

NCR Aloha

Event

OneTrust

Event

OpenAI

Event

Audience

Optimizely

Audience

Event

Oracle BlueKai

Event

Oracle Responsys

Event

Audience

Paytronix

Feed

Personify XP

Event

Persona.ly

Audience

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Pinterest

Audience

Event

Plarin

Event

Primer

Event

Postie

Audience

Event

Punchh

Audience

Event

Feed

Pushwoosh

Audience

Event

Qualtrics

Event

Quantcast

Event

Radar

Event

Feed

Reddit

Audience

Event

Apteligent

Event

Remerge

Audience

Event

Regal

Event

RevenueCat

Feed

Retina AI

Event

Feed

Reveal Mobile

Event

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Event

Audience

Feed

Rokt

Audience

Event

Rokt Thanks and Pay+

Salesforce Mobile Push

Event

Salesforce Sales and Service Cloud

Event

Feed

Samba TV

Audience

Event

Scalarr

Event

SendGrid

Audience

Feed

SessionM

Event

Feed

SFTP

Audience

Shopify

Custom Pixel

Feed

SimpleReach

Event

ShareThis

Audience

Feed

Singular

Event

Feed

Singular-DEPRECATED

Event

Slack

Event

Skyhook

Event

Smadex

Audience

Snapchat Conversions

Event

Snapchat

Event

Audience

SmarterHQ

Event

Snowplow

Event

Snowflake

Audience

Data Warehouse

Splunk MINT

Event

Split

Event

Feed

Spotify

Event

Sprig

Audience

Event

StartApp

Audience

Stormly

Event

Audience

Statsig

Event

Feed

Tapad

Audience

Talon.One

Event

Audience

Feed

Loyalty Feed

Swrve

Event

Feed

Tapjoy

Audience

Taptica

Audience

Taplytics

Event

The Trade Desk

Audience

Cookie Sync

Event

Teak

Audience

Ticketure

Feed

TikTok Event

Audience

Audience (Deprecated)

Event

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

TUNE

Event

Twitter

Event

Audience

Valid

Event

Vibe

Audience

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

X

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

Z2A Digital

Audience

Event

YouAppi

Audience

Rakuten

Event

Zendesk

Event

Feed

Audience

OpenAI Ads lets advertisers reach people with ads on OpenAI products. Custom audiences let you target, or exclude, a list of people you already know, such as existing customers or high-value users.

The mParticle OpenAI audience integration sends your mParticle audiences to OpenAI as custom audiences. mParticle creates one custom audience in OpenAI for each audience you connect, then keeps its membership up to date by adding users who enter the audience and removing users who leave it.

Prerequisites

To set up the OpenAI audience integration, you need:

  • An OpenAI Ads Manager account.
  • An OpenAI Ads API Key, created in the Settings tab of OpenAI Ads Manager. Each key is scoped to a single ad account, and mParticle creates custom audiences in that ad account. To send audiences to a different ad account, create a separate output configuration with a key from that account.

OpenAI only allows first-party data that you have the right to use for advertising. Data from data brokers isn’t allowed.

Create an OpenAI audience output configuration

  1. In mParticle, navigate to Data Platform > Setup > Outputs.
  2. Select the Audience tab and add OpenAI as an audience output.
  3. Enter a descriptive Configuration Name. You use this name to find the output configuration when you connect an audience.
  4. Enter your Ads API Key.
  5. Leave Verify Settings enabled so mParticle can confirm that your Ads API Key works. See Configuration Settings.
  6. Click Save.

Connect an audience

  1. In mParticle, navigate to Audiences and select the audience you want to send to OpenAI.
  2. Click Connect Output and select the OpenAI output configuration you created.
  3. Enter the audience name to use in OpenAI. The name must be at least 3 characters long, and it can’t be changed after the audience is created. See Audience names.
  4. Select the identities to send. At least one of Forward Email, Forward Phone, or Forward Google Advertising ID must be enabled. See Supported identities and Connection Settings.
  5. Click Save.

When you save the connection, mParticle creates an empty custom audience in your OpenAI ad account and begins sending audience members to it. If your mParticle audience has a description, mParticle uses it as the description of the OpenAI custom audience.

mParticle manages audience membership only. To use the audience for targeting or exclusion, add it to your campaigns in OpenAI Ads Manager.

Supported identities

OpenAI matches people in a custom audience by email address, phone number, and Google Advertising ID (GAID). For each audience member, mParticle sends every enabled identity that the user has. If a user is missing one identity, mParticle still sends the others.

Identity mParticle source How it’s sent
Email The identity selected in Email Identity Type: Email (the default) or one of Other through Other 10 SHA-256 hashed by default. See Hashing and formatting.
Phone number The identity selected in Phone Identity Type: Mobile Number (the default), Phone Number 2, or Phone Number 3 SHA-256 hashed by default. See Hashing and formatting.
Google Advertising ID Google Advertising ID (GAID) Unhashed, as OpenAI requires. OpenAI hashes it.

If you select one of the Other identity types for email, make sure that identity holds an email address.

Hashing and formatting

By default, mParticle formats and hashes email addresses and phone numbers before sending them to OpenAI:

  • Email addresses are trimmed and converted to lowercase, then SHA-256 hashed. Values that aren’t shaped like an email address aren’t sent.
  • Phone numbers are formatted in E.164 format with a leading plus sign (for example, +14155552671), then SHA-256 hashed. Phone numbers without a country code are treated as US numbers, so include the country code for phone numbers outside the US. Values that can’t be read as a phone number aren’t sent.

Identities you’ve already hashed

If you hash email addresses or phone numbers before sending them to mParticle, set Email Source Format or Phone Source Format to SHA-256 digest hashed upstream. mParticle sends these values to OpenAI unchanged and doesn’t hash them again.

For OpenAI to match pre-hashed values, you must hash them the same way OpenAI does:

  • Email: the SHA-256 hash of the trimmed, lowercase email address.
  • Phone number: the SHA-256 hash of the E.164 phone number, including the leading plus sign.

A pre-hashed value must be a 64-character hexadecimal SHA-256 hash. mParticle doesn’t send values in any other format, including plain email addresses or phone numbers, when the source format is set to SHA-256.

Upload frequency

The OpenAI audience integration uses bulk forwarding. Instead of sending each change to an audience in real time, mParticle queues audience updates and sends them when either of the following conditions is met:

  • 3 hours have passed since the last upload.
  • At least 500,000 updates are in the queue.

Because of this, it can take several hours for changes in your mParticle audience to appear in OpenAI. Contact your mParticle account representative if you need to discuss upload frequency.

Audience size

OpenAI applies a minimum matched audience size, based on how many audience members OpenAI can match to its users, not how many members mParticle sends:

  • Targeting (inclusion) and bid adjustments: the audience must meet OpenAI’s matched-user minimum. OpenAI recommends planning for at least 25,000 matched users. Sending 25,000 identities doesn’t guarantee 25,000 matches.
  • Exclusion: no minimum. You can exclude a small audience, or one that’s still empty.

If you combine inclusion and exclusion audiences in a campaign, the remaining eligible audience must still meet the minimum. See OpenAI’s custom audiences documentation for details.

Audience names

OpenAI doesn’t support renaming custom audiences. The name you enter when you connect an audience is fixed when mParticle creates the OpenAI custom audience. Renaming the audience in mParticle doesn’t rename it in OpenAI.

Deleting an audience

OpenAI doesn’t support deleting custom audiences. When you delete an audience or disconnect it from OpenAI in mParticle, mParticle stops sending updates, but the custom audience remains in your OpenAI ad account. If you no longer need it, you can archive it in OpenAI Ads Manager. Archiving is permanent in OpenAI.

Troubleshooting

If OpenAI rejects your Ads API Key, for example because the key was revoked, mParticle can’t create audiences or send updates. Create a new Ads API Key in OpenAI Ads Manager and update it in your OpenAI output configuration.

Configuration Settings

Configuration settings apply to every audience connected to the output configuration.

Setting Name Data Type Default Value Description
Ads API Key string Required. The Ads API key created in OpenAI Ads Manager.
Verify Settings bool True If enabled, mParticle confirms that your Ads API Key works before it sends audience data to OpenAI. If the key doesn’t work, no data is sent until you update the key. Leave this enabled.

Connection Settings

Connection settings apply to each audience you connect to OpenAI.

Setting Name Data Type Default Value Description
Forward Email bool True If enabled, sends the identity selected in Email Identity Type as the email identifier.
Email Identity Type enum Email The mParticle identity to send as the email identifier: Email, or one of Other through Other 10 that holds an email address.
Email Source Format enum Plain value Whether your email values are plain text or already hashed. Select Plain value if you store plain email addresses. mParticle hashes them for you when Hash Identities is enabled. Select SHA-256 digest hashed upstream if you hashed the email addresses before sending them to mParticle. mParticle sends them as they are. See Identities you’ve already hashed.
Forward Phone bool True If enabled, sends the identity selected in Phone Identity Type as the phone identifier.
Phone Identity Type enum Mobile Number The mParticle identity to send as the phone identifier: Mobile Number, Phone Number 2, or Phone Number 3.
Phone Source Format enum Plain value Whether your phone values are plain text or already hashed. Select Plain value if you store plain phone numbers. mParticle hashes them for you when Hash Identities is enabled. Select SHA-256 digest hashed upstream if you hashed the phone numbers before sending them to mParticle. mParticle sends them as they are. See Identities you’ve already hashed.
Forward Google Advertising ID bool True If enabled, sends the Google Advertising ID. OpenAI requires it unhashed and hashes it itself.
Hash Identities bool True If enabled, mParticle SHA-256 hashes plain email addresses and phone numbers before sending them. Values that were hashed upstream are never hashed again.
    Last Updated: November 18, 2026