Skip to content
User Guide
Developer Guide
API
Technology Partners
What's New
EN
DE
ES
FR
JA
KO
PT-BR
EN
DE
ES
FR
JA
KO
PT-BR
User Guide
Home
User Guide
Developer Guide
API
Technology Partners
What's New
braze.com
braze.com
Press Arrow down to open the documentation menu without expanding the sidebar.
Home
Get started
Users and segments
Campaigns and Canvases
Workspaces
Integration
SDK overview
Terms to know
Braze Pilot
Get started
Data dictionary
Navigation deep links
B2B use cases
Data models
Lead scoring
Account-based segmentation
Salesforce Sales Cloud
Administer
Personal
Access your account
The dashboard
Language settings
Product portal
Braze Support
API and SDK endpoints
Global
Create and manage workspaces
User management
Company users
Permissions
Granular permissions migration
Teams
Automated user provisioning
Internal groups
SAML and single sign-on
SAML SSO setup
SAML Just-in-Time provisioning
Microsoft Entra SSO
Okta
OneLogin
Admin settings
Contact information
Notification preferences
Security settings
Security events export with S3
Workspace time zones
Workspace settings
APIs and identifiers
Brand guidelines
Email preferences
Bot filtering for emails
Logs and alerts
API usage alerts
Event user log
Exports log
Message activity log
Localization settings
Push settings
Managing tags
Messaging rate limits
Billing
Message Usage dashboard
Privacy
Spam regulations
Manage consent
Data
Unification
Cloud Data Ingestion
Best practices
Connected sources
Table setup
Data warehouse integrations
File storage integrations
Sync and delete account data
Sync and delete catalog data
Zero-copy personalization
Sync logs and observability
Delete users with CDI
FAQ
Data Transformation
Create a transformation
Use cases
Create a formula
User data
SDK data collection
User profile lifecycle
Anonymous users
Collection use case
Collection best practices
Language codes
Activation
Custom data
Data types
Manage custom data
Blocklist custom data
Attributes
Custom attributes
Array of objects
Nested custom attributes
Events
Custom events
Custom event properties
Nested objects
Recommended events
Use eCommerce recommended events
Product blocks
Purchase events
Event naming conventions
Catalogs
Create a catalog
Using catalogs
Catalog triggers
Back-in-stock notifications
Price drop notifications
Selections
Distribution
Currents
Set up Currents
Available partners
Event delivery semantics
Custom HTTP Connector
Currents event glossary
Currents changelog
Customer behavior and user events
User Profiles
Message engagement events
Use cases
How Braze uses Currents
Transfer data from Amazon S3 to Snowflake
Transfer data to Redshift
FAQ
Export Braze data
Message archiving
Campaign data
Canvas data
Segment data
Export APIs
Troubleshooting
FAQ
Infrastructure
Data centers
Identifier field-level encryption
Data points
Audience
Your audience
Manage audience
User profiles
Delete users
Import users
CSV import
Merge duplicate users
Merge behavior
Segments
Create a segment
Manage segments
Segmentation filters
Segment data
Measure segment size
Segment Extensions
CDI Segment Extensions
SQL Segment Extensions
Catalog segments
RFM segments
Use cases
SQL table reference
Segment Insights
Location targeting
Regular expressions
Troubleshooting
Use case: Nested custom attributes
Locations and geofences
Location tracking
Create geofences
Subscription preferences
Preference center
API email preference center
Drag-and-drop email preference center
Global Control Group
Suppression lists
Messaging
Fundamentals
Accessibility
Conversion events
Delivery and entry types
Rate limiting and frequency capping
Know before you send
Localization
Multi-language messages
Right-to-left messages
Re-eligibility
Send test messages
Target users
Governance
Approvals
Messaging rules
Archive
Copy across workspaces
Duplicate
Statuses
Tags
Campaigns
Campaign basics
Create a campaign
Manage campaigns
Edit your campaign after launch
Campaign alerts
Search for campaigns
Schedule your campaign
Scheduled delivery
Action-based delivery
Attribute triggers
Campaign Connector
API-triggered delivery
Content calendar
Test campaigns
API-triggered and action-based campaigns
Campaign analytics
Retention reports
Funnel reports
Ideas and strategies
Best practices
Active user campaigns
Add-to-calendar links
Capture lapsing users
Automate Zoom registration
Retargeting campaigns
Understanding user installs
Booking reminder email
Feature awareness and new app version
FAQ
Canvas
Canvas basics
Create a Canvas
Comments in Canvas
Exit criteria
Context and event properties
Persistent entry properties
Canvas by channel
Content Cards
In-app messages
Canvas components
Action Paths
Agent
Audience Paths
Audience Sync
Experiment Paths
Personalized Paths
Winning Path
Content Optimizer
Context
Decision Split
Delay
Feature Flag
Message
Send to Destination
User Update
Manage Canvases
Edit Canvases after launch
Save drafts for Canvas
Canvas version history
Cloning Canvases
Test Canvases
Preview user paths
Send test Canvases
Canvas analytics
Retention reports
Funnel reports
Ideas and strategies
Canvas outlines
Best practices
Pre and post-launch checklist
Launch with Canvas Flow
eCommerce use cases
Matching exit criteria to entry events
Booking reminder email
Troubleshooting
FAQ
Design and edit
Personalize
Dashboard tools
Sources
User profile
REST API
Catalog
Canvas entry properties
Key-value pairs
Promotion codes
Create codes
Use codes
Migrate from Data Feeds
Context variables
Action and media URLs
Liquid reference
Use Liquid
Supported personalization tags
Operators
Filters
Advanced filters
Message extras tag
Set default values
Conditional messaging logic
Abort messages
Liquid use case library
Tutorials
FAQ
Connected Content reference
Make a Connected Content call
Local Connected Content variables
Abort Connected Content
Cache responses
Pull user profile data
Connected Content retries
Use public APIs
Media library
Image specifications
FAQ
Editor blocks
Content Blocks
Product blocks
Templates
Manage templates
Canvas templates
Use Braze templates
Abandoned cart
Back in stock
Email sign-up with double opt-in
Feature adoption
Lapsed user
Onboarding
Onboarding with preferences survey
Post-purchase feedback
Email templates
Create an email template
Upload an HTML email template
Link aliasing
Link templates
FAQ
In-app message templates
Create an in-app message template
Onboarding flow
SMS, RCS, and WhatsApp sign-up form
Email sign-up form
Email sign-up with discount
Email sign-up with image
Email sign-up with offer
Email sign-up with confirmation
Product announcement
Seasonal promotion with image
Webhook templates
A/B tests
Concepts
Variant distribution
Random bucket numbers
Conversion correlation
Race conditions
Create tests
Optimizations
Analytics
FAQ
Feature flags
Create feature flags
Feature flags in Canvas
Feature flag experiments
FAQ
Landing pages
Create landing pages
Customize the URL
Track users
Retarget users
Personalize landing pages
About tracking data
Channels
Banners
Create a Banner
Custom code and JavaScript bridge
Reporting
FAQ
Content Cards
Create a Content Card
Card creation
Creative details
Reporting
Best practices
Improve low latency
Know before you send
Email
Setup
Set up IPs and domains
Amazon SES setup
IP warming
Automated IP warming
Email authentication
Email validation
Import your email list
SSL at Braze
Consent and address collection
Deliverability pitfalls and spam traps
Open pixel and click tracking
Drag-and-drop editor
Editor blocks
FAQ
HTML editor
CSS inlining
Gmail Promotions tab
Troubleshooting
Customize
Email global style settings
Universal links and App Links
Custom email footer
AMP for email
Subscriptions
Use cases
Inbox Vision
Reporting
Email analytics glossary
Best practices
Email guidelines
Email styling
Email deliverability
Apple Mail
Send emails to Apple Private Relay
Apple Mail Privacy Protection
Sunset policies
Know before you send
FAQ
KakaoTalk
Set up KakaoTalk
Create a KakaoTalk message
KakaoTalk reporting
KakaoTalk click tracking
Transactional email
Create a transactional email
Set up tracking
In-app messages
Drag-and-drop editor
Traditional editor
Message types
Fullscreen
Modal
Slideup
Custom HTML
Email capture form
Simple survey
Customize
Style settings
Dark mode themes
Video in custom HTML
Reporting
Best practices
Prep guide
In-app rating prompt for iOS
Know before you send
FAQ
LINE
Setup
Create a LINE message
Message types
LINE click tracking
Message users
User management
Subscription groups
Reporting
Push
Setup
Push token lifecycle
Push subscription states
Create a push message
Message and image formats
Push action buttons
Push Stories
Quick push messages
Message types
Platform-specific resources
Android options
Notification options
Create rich notifications
Notification channels
Advanced push campaign settings
Push Max
iOS options
Notification options
Custom app icon feature (iOS 10.3)
Create rich notifications
Utilizing badge count
Web push
Troubleshooting
Reporting
Best practices
Push primer in-app messages
Deliverability for Chinese Android devices
Know before you send
Common push error messages
FAQ
SMS, MMS, and RCS
Setup
RCS setup
Sender setup
A2P 10DLC
10DLC application
User phone numbers
SMS sending
Subscription groups
Terms to know
Create a message
Contact cards
Features and optimization
Link shortening
Self-serve custom domains
Keyword processing
Opt-in and opt-out keywords
Double opt-in
Custom keyword handling
Handle unknown phone numbers
Fuzzy opt-out
User retargeting
Bot click filtering
Compliance and delivery
Laws and regulations
Best practices
Collect user opt-ins
Geographic permissions
Know before you send
Billing calculator
Reporting
FAQ
Webhooks
Create a webhook
Use case: Create a Braze-to-Braze webhook
Reporting
WhatsApp
Setup
Embedded signup
BYO WhatsApp connector
User phone numbers
Subscription groups
Multiple business accounts
WhatsApp phone numbers
Acquire a number
Migrate a number
Transfer between workspaces
Create a WhatsApp message
Message and image formats
Message processing
Quality rating and messaging limits
Opt-ins and opt-outs
User messages
Handle unknown phone numbers
Features and optimization
Optimized delivery
Click tracking
WhatsApp Flows
Product messages
User retargeting
Custom domains
WhatsApp Template Builder
Carousel templates
Use cases
Ads That Click to WhatsApp
WhatsApp and external systems
Meta resources
Reporting
Best practices
FAQ
Analytics
Dashboards
Home
Channel performance
Conversions
Deliverability Center
API usage
Dashboard Builder
eCommerce revenue dashboard
Messaging diagnostics dashboard
Reports
Campaign analytics
Canvas analytics
Report Builder
Report Builder (legacy)
Query Builder
Build queries
Query templates
SQL variables
Metrics by segments
Engagement reports
Custom events report
Revenue report
Funnel reports
Retention reports
Configure reporting
Tracking
Uninstall tracking
Influenced opens
Segment analytics tracking
Metrics glossary
BrazeAI
Agent Console
Create agents
Deploy agents
Reference
FAQ
Content Optimizer
Braze MCP server
Braze MCP server setup
Using the Braze MCP server
Available API functions
Decisioning Studio
Get started
Design decisioning agents
Prepare your data
General principles
Critical data assets
Snapshots versus event streams
Use Braze external ID
Connect your data
Backfilling best practices
Choose your features
Define your audience
Set up orchestration
Launch your agent
Reports and insights
Performance
Insights
Diagnostics
Timeline
Decisioning Studio Go
Connect data sources
Set up orchestration
Design your agent
Launch your agent
FAQ
Generative AI
Liquid code
SQL Segment Extensions
SQL queries
Copywriting
Brand guidelines
Content QA
Images
Intelligence Suite
Intelligent Selection
Intelligent Timing
Channel filter
Tutorial: Quick service restaurant
Operator
Review actions
Support tickets
Troubleshooting
Predictive Suite
Predictive Churn
Create a churn prediction
Messaging users
Churn analytics
Troubleshooting
Use case
Predictive Events
Create an Event Prediction
Messaging users
Event analytics
Use case
Item recommendations
Create recommendations
AI recommendations
Rules-based recommendations
Using recommendations
Analytics
Use case
Privacy portal
Press
Esc
to close the menu
BRAZE SYSTEM STATUS
Checking Braze Status
User management
Manage company users, permissions, teams, and provisioning.
Section articles
Company users
Permissions
Teams
Automated user provisioning
Internal groups
New Stuff!
