Product
Industries
Customers
Perspectives
Resources
About
Contact
Login
Documentation
User Guide
Developer Guide
API
Technology Partners
Help
API
Documentation
User Guide
Developer Guide
API
Technology Partners
Help
Braze.com
Overview
Endpoints
Email Lists & Addresses
GET: Query Hard Bounced Emails
GET: Query List of Unsubscribed Email Addresses
POST: Change Email Subscription Status
POST: Remove Hard Bounced Emails
POST: Remove Email Addresses from Spam List
POST: Blacklist Emails
Export
Campaigns
GET: Campaign Analytics
GET: Campaign Details
GET: Campaigns List
GET: Send Analytics
Canvas
GET: Canvas Data Series Analytics
GET: Canvas Data Summary Analytics
GET: Canvas Details
GET: Canvas List
Custom Events
GET: Custom Events List
GET: Custom Events Analytics
KPIs
GET: Daily New Users by Date
GET: Daily Active Users by Date
GET: Monthly Active Users for Last 30 Days
GET: KPIs for Daily App Uninstalls by Date
News Feed
GET: News Feed Card Analytics
GET: News Feed Card Details
GET: News Feed Cards List
Segments
GET: Segments List
GET: Segment Analytics
GET: Segment Details
Sessions
GET: App Sessions by Time
User Data
POST: User Profile Export by Identifier
POST: User Profile Export by Segment
Messaging
Schedule Messages
GET: List Upcoming Scheduled Campaigns and Canvases
POST: Delete Scheduled Messages
POST: Delete Scheduled API Triggered Campaigns
POST: Schedule Messages
POST: Schedule API Triggered Campaign Messages
POST: Schedule API Triggered Canvas Messages
POST: Update Scheduled Messages
POST: Update Scheduled API Triggered Campaign Messages
POST: Update Scheduled API Triggered Canvas Messages
Send Messages
POST: Create Send IDs
POST: Send Messages Immediately via API Only
POST: Send Campaign Messages via API Triggered Delivery
POST: Send Canvas Messages via API Triggered Delivery
Subscription Groups
GET: List Users' Subscription Group Status
GET: List User's Subscription Groups
POST: Update User's Subscription Group Status
Templates
Content Blocks Templates
GET: List Available Content Blocks
GET: See Content Blocks Information
POST: Create Content Block
POST: Update Content Block
Email Templates
GET: List Available Email Templates
GET: See Email Template Information
POST: Create Email Template
POST: Update Email Template
User Data
POST: Create New User Alias
POST: User Delete
POST: Identify Users
POST: User Track
External ID Migration
POST: External ID Rename
POST: External ID Remove
Objects & Filters
Android Objects
Apple Objects
Canvas Entry Properties Objects
Connected Audience Filter & Object
Content Card Objects
Email Object
Event Object
Kindle and FireOS Push Object
Purchase Object
Recipient Object
SMS Object
Aliases to Identify Object
Trigger Properties Object
User Alias Object
User Attributes Object
Schedule Objects
Web Objects
Webhook Object
Windows Objects
API Key Overview
API Identifier Types
Errors & Responses
Parameters
Data Retention
Postman & Sample Requests
API Network Connectivity Issues
API Campaigns
BRAZE SYSTEM STATUS
Checking Status
Edit this page on GitHub
WAS THIS PAGE HELPFUL?
Yes
Yes, but...
No
SUBMIT FEEDBACK
Edit this page on GitHub
New Stuff!
Edit this page on GitHub