Skip to content
User Guide
Developer Guide
API
Technology Partners
Help
EN
ES
FR
JA
KO
PT-BR
EN
ES
FR
JA
KO
PT-BR
API
Home
User Guide
Developer Guide
API
Technology Partners
Help
braze.com
braze.com
Home
Endpoints
Catalogs
Catalog Management
Synchronous
DELETE: Delete Catalog
GET: List Catalogs
POST: Create Catalog
Catalog Items
Asynchronous
DELETE: Delete Multiple Catalog Items
PATCH: Edit Multiple Catalog Items
POST: Create Multiple Catalog Items
PUT: Update Multiple Catalog Items
Synchronous
DELETE: Delete Catalog Item
GET: List Catalog Item Details
GET: List Multiple Catalog Item Details
PATCH: Edit Catalog Item
POST: Create Catalog Item
PUT: Update Catalog Item
Catalog Fields
Asynchronous
DELETE: Delete Catalog Field
POST: Create Catalog Fields
Catalog Selections
Asynchronous
DELETE: Delete Catalog Selection
POST: Create Catalog Selection
Cloud Data Ingestion
GET: List Integrations
GET: List Job Sync Status
POST: Trigger Sync
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: Blocklist Emails
POST: Blacklist Emails
Export
Campaigns
GET: Export Campaign Analytics
GET: Export Campaign Details
GET: Export Campaigns List
GET: Export Send Analytics
Canvas
GET: Export Canvas Data Series Analytics
GET: Export Canvas Data Summary Analytics
GET: Export Canvas Details
GET: Export Canvas List
Custom Events
GET: Export Custom Events List
GET: Export Custom Events Analytics
GET: Export Custom Events
KPIs
GET: Export Daily New Users by Date
GET: Export Daily Active Users by Date
GET: Export Monthly Active Users for Last 30 Days
GET: Export KPIs for Daily App Uninstalls by Date
News Feed
GET: Export News Feed Card Analytics
GET: Export News Feed Card Details
GET: Export News Feed Cards List
Purchases
GET: Export Product IDs
GET: Export Revenue Data
GET: Export Number of Purchases
Segments
GET: Export Segment List
GET: Export Segment Analytics
GET: Export Segment Details
Sessions
GET: Export App Sessions by Time
User Data
POST: Export User Profile by Identifier
POST: Export User Profile by Segment
POST: Export User Profile by Global Control Group
Custom Attributes
GET: Export Custom Attributes
Messages
POST: Duplicate Campaigns
Live Activity
POST: Start Live Activity
POST: Update Live Activity
Schedule Messages
GET: List Upcoming Scheduled Campaigns and Canvases
POST: Delete Scheduled Messages
POST: Delete Scheduled API-Triggered Canvases
POST: Delete Scheduled API-Triggered Campaigns
POST: Create Scheduled Messages
POST: Schedule API-Triggered Campaigns
POST: Schedule API-Triggered Canvases
POST: Update Scheduled Messages
POST: Update Scheduled API-Triggered Campaigns
POST: Update Scheduled API-Triggered Canvases
Send Messages
POST: Create Send IDs
POST: Send Messages Immediately Using the API Only
POST: Send Transactional Emails Using API-Triggered Delivery
POST: Send Campaigns Using API-Triggered Delivery
POST: Send Canvas Messages Using API-Triggered Delivery
Post duplicate canvas
Preference Center
GET: Generate Preference Center URL
GET: List Preference Centers
GET: View Details for Preference Center
POST: Create Preference Center
PUT: Update Preference Center
SCIM
DELETE: Remove Dashboard User Account
GET: Search Existing Dashboard User Account by Email
GET: Look Up an Existing Dashboard User Account
POST: Create New Dashboard User Account
PUT: Update Dashboard User Account
SMS
GET: Query Invalid Phone Numbers
POST: Remove Invalid Phone Numbers
Subscription Groups
GET: List Users' Subscription Group Status
GET: List User's Subscription Groups
POST: Update User's Subscription Group Status
POST: Update User's Subscription Group Status V2
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
Translations
GET: View Translations for a Campaign
GET: View Translations for a Canvas
GET: View Translation for a Campaign
GET: View Translation for a Canvas
PUT: Update Translation in a Campaign
PUT: Update Translation in a Canvas
User Data
POST: Create New User Alias
POST: Update User Alias
POST: Identify Users
POST: Track Users
POST: Delete Users
POST: Merge Users
External ID Migration
POST: Rename External ID
POST: Remove External ID
Objects & Filters
Canvas Entry Properties Object
Connected Audience Filter & Object
Event Object
Purchase Object
Recipients Object
Aliases to Identify Object
Trigger Properties Object
User Alias Object
User Attributes Object
Schedule Object
Message Objects
Android Objects
Apple Object
Content Card Object
Email Object
Kindle and FireOS Push Object
SMS Object
Web Object
Webhook Object
WhatsApp Object
API Overview
API Identifier Types
Errors & Responses
Data Retention
Postman and Sample Requests
API Network Connectivity Issues
Rate Limits
API Use Cases
API Campaigns
Transactional Campaigns
BRAZE SYSTEM STATUS
Checking Braze Status
Cloud Data Ingestion Endpoints
Use the Braze Cloud Data Ingestion endpoints to manage your data warehouse integrations and syncs.
GET: List Integrations
GET: List Job Sync Status
POST: Trigger Sync
New Stuff!
