Skip to content
User Guide
Developer Guide
API
Technology Partners
Help
EN
FR
JA
EN
FR
JA
User Guide
Home
User Guide
Developer Guide
API
Technology Partners
Help
braze.com
braze.com
Home
Getting Started
Braze Overview
Users and Segments
Campaigns and Canvases
Workspaces
Integration
SDK Overview
Terms to Know
B2B Use Cases
Data Models
Lead Scoring
Account-Based Segmentation
Administrative
Access Braze
Navigation
Searching Your Braze Dashboard
API and SDK Endpoints
Accessing Your Account
Language Settings
SAML & Single Sign-On
SAML SSO Setup
SAML Just-in-Time Provisioning
Microsoft Entra SSO
Okta
OneLogin
Product Portal
Settings
Creating and Managing Workspaces
APIs and Identifiers
Message Activity Log
Multi-Language Settings
Event User Log
Internal Groups
Tags
Email Preferences
Push TTL Settings
Admin Settings
Contact Information
Notification Preferences
Security Settings
Automated User Provisioning
Company Users
Users
Permissions
Teams
Billing
Privacy
Spam Regulations
Managing Consent
Data & Analytics
Data Points
Report Metrics Glossary
Cloud Data Ingestion
Overview
Connected Sources
Data Warehouse Integrations
File Storage Integrations
Sync and Delete Catalog Data
Delete Users with CDI
FAQs
Data Transformation
Overview
Creating a Transformation
Use Cases
Creating a Formula
Currents
Setting Up Currents
Available Partners
Event Delivery Semantics
Currents Event Glossary
Customer Behavior and User Events
Message Engagement Events
How Braze Uses Currents
Transferring Data from Amazon S3 to Snowflake
Transferring Data to Redshift
User Data Collection
SDK Data Collection
User Profile Lifecycle
Collection Use Case
Collection Best Practices
User Import
User Language Codes
Custom Data
Events
Purchase Events
Custom Events
Nested Objects
Custom Attributes
Array of Objects
Nested Custom Attributes
Event Naming Conventions
Managing Custom Data
Tracking
Email Open Pixel and Click Tracking
Uninstall Tracking
Influenced Opens
Segment Analytics Tracking
Exporting Braze Data
Export Campaign Data
Message Archiving
Export Canvas Data
Export Segment Data to CSV
Export Usage Analytics
Export Revenue & Total Revenue Data
Export Custom Event Aggregates
Export APIs
Opening CSV Reports in Excel
Export Troubleshooting
FAQ
Your Analytics Dashboards
Home Dashboard
Channel Performance Dashboard
Conversions Dashboard
Deliverability Center
Your Reports
Reports Overview
Configuring Reporting
Segment Data
Metrics by Segments
Engagement Reports
Report Builder
Campaign Analytics
Canvas Analytics
Retention Reports
Funnel Reports
Global Control Group
Revenue Report
Catalogs
Query Builder
Query Templates
Identifier Field-Level Encryption
Engagement Tools
Segments
Creating a Segment
Managing Segments
Segmentation Filters
Segment Funnels
Segment Extensions
CDI Segments
SQL Segment Extensions
Catalog Segments
Use Cases
SQL Table Reference
Segment Insights
User Profiles
Duplicate Users
Regular Expressions
Location Targeting
Troubleshooting
Campaigns
Getting Started
Campaign Basics
Understanding Campaign Status
Building Campaigns
Create a Campaign
Time-Based Functionalities for Campaigns
Scheduling Your Campaign
Scheduled Delivery
Action-Based Delivery
Attribute Triggers
Campaign Connector
API-Triggered Delivery
Re-eligibility for Campaign and Canvas
Content Calendar
Targeting Users
Conversion Events
Rate Limiting and Frequency Capping
Managing Campaigns
Approving Campaigns
Copying Across Workspaces
Editing Your Campaign After Launch
Archiving Campaigns
Duplicating Segments, Campaigns, and Canvases
Campaign Alerts
Searching for Campaigns
Testing Campaigns
Sending Test Messages
API-Triggered and Action-Based Campaigns
Campaign Analytics
Retention Reports
Funnel Reports
Ideas and Strategies
Best Practices
Active User Campaigns
Add-to-Calendar Links
Capturing Lapsing Users
Automate Zoom Registration
Retargeting Campaigns
Localization
Understanding User Installs
Feature Awareness and New App Version
FAQ
Canvas
Getting Started
Canvas Basics
Using Braze Templates
Abandoned Cart
Back In Stock
Feature Adoption
Lapsed User
Onboarding
Post-Purchase Feedback
Understanding Canvas Status
Canvas Outlines
Building Canvases
Creating a Canvas
Commenting in Canvas
Creating a Canvas Template
Time-Based Functionalities
Rate Limiting
Exception Events
Exit Criteria
Canvas Entry Properties and Event Properties
Persistent Entry Properties
Canvas by Channel
Content Cards
In-App Messages
Advancement Behaviors
Canvas Components
Action Paths
Audience Paths
Decision Split
Delay
Experiment Paths
Personalized Paths
Winning Path
Message
User Update
Feature Flags
Canvas Audience Sync
Managing Canvases
Editing Canvases After Launch
Canvas Approval and Permissions
Saving Drafts for Canvas
Canvas Version History
Cloning Canvases
Duplicating Canvases
Archiving Canvases
Testing Canvases
Preview User Paths
Sending Test Canvases
Canvas Analytics
Retention Reports
Funnel Reports
Ideas and Strategies
Best Practices
Pre and Post-Launch Checklist
Launching with Canvas Flow
Localization
FAQ
Templates and Media
Media Library
Content Blocks Library
Canvas Templates
Managing Templates
Image Specifications
FAQ
Locations and Geofences
Location Tracking
Creating Geofences
Mobile Integrations
FAQ
Engagement Testing
Global Control Group
Multivariate & A/B Testing
Creating Tests
Optimizations
Analytics
Random Bucket Numbers
Conversion Correlation
Race Conditions
Landing Pages
Drag-and-Drop Editor
Connecting Your Domain
Message Building by Channel
Content Cards
About Content Cards
Creating a Content Card
Card Creation
Creative Details
Testing
Reporting
Migrating from News Feed
Best Practices
Know Before You Send
Email
About Email
Email Setup
Setting Up IPs & Domains
IP Warming
Email Authentication
Email Validation
Importing Your Email List
SSL at Braze
Consent & Address Collection
Deliverability Pitfalls & Spam Traps
Drag-And-Drop Editor
Creating an Email
Editor Blocks
Content Blocks
Email Global Style Settings
FAQ
HTML Editor
Creating an Email
CSS Inlining
Gmail Promotions Setup
Templates
Creating an Email Template
Uploading an HTML Email Template
Link Aliasing
Link Templates
FAQ
Email Subscriptions
Locales in Messages
Custom Email Footer
Apple Mail
Sending Emails to Apple Private Relay
Apple Mail Privacy Protection
Preference Center
Overview
Drag-And-Drop Email Preference Center
Inbox Vision
Transactional Email Campaigns
AMP for Email
Reporting & Analytics
Email Analytics Glossary
Reporting
Best Practices
Email Guidelines
Email Styling
Email Use Cases
Sanitization
Duplicate Emails
Sunset Policies
Email Services
Know Before You Send
FAQ
In-App Messages
About In-App Messages
Drag-And-Drop Editor
Creating an In-App Message
Style Settings
Editor Blocks
Templates
Email Sign-up Form
SMS and WhatsApp Sign-up Form
Traditional Editor
Creating an In-App Message
Customize
HTML In-App Messages
Email Capture Form
Color Profiles and CSS Templates
Video
Templates
Simple Survey
Dark Mode Themes
Creative Details
Fullscreen
Modal
Slideup
Testing
Reporting
In-App Rating Prompt for iOS
Best Practices
Prep Guide
Know Before You Send
FAQ
LINE
LINE Setup
Creating a LINE Message
Message Types
Messaging Users
LINE Users
User Management
Subscription Groups
Push
About Push Notifications
Types of Push Notifications
Push Registration
Push Enablement and Subscription
Creating a Push Message
Quick Push Campaigns
Advanced Push Options
Push Action Buttons
Push Stories
Android Options
Notification Options
Creating Rich Notifications
Notification Channels
Advanced Push Campaign Settings
Push Max
iOS Options
Notification Options
Creating Rich Notifications
Advanced Push Campaign Settings
Custom App Icon Feature (iOS)
Utilizing Badge Count
Web Push
Best Practices
Push Primer In-App Messages
Message Formats
Deliverability for Chinese Android Devices
Know Before You Send
Reporting
SMS and MMS
About SMS
SMS Setup
Terms to Know
Sending Phone Numbers
SMS Message Sending
User Data Migration
SMS Laws & Regulations
SMS Subscription Groups
SMS Geographic Permissions
Phone Numbers
User Phone Numbers
A2P 10DLC
10DLC Application
SMS Campaign
Creating an SMS message
Link Shortening
Message Copy and Segment Calculator
User Retargeting
Keyword Processing
Opt-In & Opt-Out Keywords
Fuzzy Opt-Out
SMS Double Opt-In
Custom Keyword Handling
Handling Unknown Phone Numbers
Reporting
Best Practices
SMS/MMS Best Practices
Collecting User Opt-Ins
Know Before You Send
FAQ
MMS
About MMS
MMS Short and Long Codes
Creating an MMS Campaign
Contact Cards
FAQ
Webhooks
About Webhooks
Creating a Webhook
Creating a Webhook Template
Creating a Braze-to-Braze Webhook
Lead Scoring
Reporting
WhatsApp
WhatsApp Setup
Embedded Signup
Multiple Business Accounts
WhatsApp Phone Number Migration
Phone Number Acquisition
Subscription Groups
User Phone Numbers
WhatsApp Campaign
Creating a WhatsApp Message
User Retargeting
Message Processing
Opt-Ins & Opt-Outs
Messaging Users
Handling Unknown Phone Numbers
Quality Rating and Messaging Limits
Reporting
Best Practices
FAQ
Meta Resources
Personalization & Dynamic Content
Liquid
Using Liquid
Supported Personalization Tags
Operators
Filters
Advanced Filters
Message Extras Tag
Setting Default Values
Conditional Messaging Logic
Aborting Messages
Liquid Use Case Library
Tutorials
FAQ
Connected Content
Making an API Call
Local Connected Content Variables
Aborting Connected Content
Connected Content Retries
Public APIs
Pulling User Profile Data
Deep Linking to In-App Content
Key-Value Pairs
Promotion Codes
Migrating from Data Feeds to Promotion Codes
Canvas Persistent Entry Properties
Catalogs
Creating a Catalog
Using Catalogs
Catalog Triggers
Back-In-Stock Notifications
Price Drop Notifications
Selections
BrazeAI
Predictive Suite
Predictive Churn
Creating a Churn Prediction
Prediction Analytics
Prediction Quality
Messaging Users
Troubleshooting
Predictive Events
Creating an Event Prediction
Prediction Analytics
Messaging Users
Intelligence Suite
Intelligent Channel Filter
Intelligent Selection
Intelligent Timing
FAQ
Recommendations
About Item Recommendations
AI Item Recommendations
Rules-based Recommendations
Generative AI
AI Copywriting Assistant
Brand Guidelines
BrazeAI Liquid Assistant
About Prompting
Content QA with AI
Privacy Portal
BRAZE SYSTEM STATUS
Checking Braze Status
Settings
This is where you can find topics related to global settings for your workspace.
Setup and testing
Workspace Management
API Keys
Message Activity Log
Event User Log
Internal Groups
Identifier Field-Level Encryption
Workspace settings
Tags
Email Preferences
Push TTL Settings
Multi-Language Settings
Company settings
Admin Settings
Company Users
Billing
Data settings
Custom Data
New Stuff!