Skip to content

User Guide
Developer Guide
API
Technology Partners
What's New

API

Home
User Guide
Developer Guide
API
Technology Partners
What's New

braze.com

Press Arrow down to open the documentation menu without expanding the sidebar.

DELETE: Delete catalog

GET: List catalogs

POST: Create catalog

DELETE: Delete multiple catalog items

PATCH: Edit multiple catalog items

POST: Create multiple catalog items

PUT: Replace multiple catalog items

DELETE: Delete catalog item

GET: List catalog item details

GET: List multiple catalog item details

PATCH: Edit catalog item

POST: Create catalog item

PUT: Replace catalog item

DELETE: Delete catalog field

POST: Create catalog fields

DELETE: Delete catalog selection

POST: Create catalog selection

Cloud data ingestion

GET: List integrations

GET: List job sync status

POST: Trigger sync

Email lists and 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

GET: Export campaign analytics

GET: Export campaign details

GET: Export campaigns list

GET: Export send analytics

GET: Export Canvas data series analytics

GET: Export Canvas data summary analytics

GET: Export Canvas details

GET: Export Canvas list

GET: Export custom events list

GET: Export custom events analytics

GET: Export custom events

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

GET: Export product IDs

GET: Export revenue data

GET: Export number of purchases

GET: Export segment list

GET: Export segment details

GET: Export segment analytics

POST: Cancel exports by segment

GET: Export app sessions by time

POST: Export user profile by identifier

POST: Export user profile by segment

POST: Export user profile by global control group

GET: Export custom attributes

POST: Upload an asset to the media library

PUT: Replace an asset in the media library

POST: Duplicate campaigns

POST: Duplicate Canvases

POST: Start live activity

POST: Update live activity

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

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

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

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

SDK authentication

POST: Create SDK authentication key

GET: List SDK authentication keys

PUT: Set primary SDK authentication key

DELETE: Remove SDK authentication key

GET: Query invalid phone numbers

POST: Remove invalid phone numbers

Subscription groups

GET: List users' subscription group status

GET: List users subscription groups

POST: Update users subscription group status

POST: Update users subscription group status v2

GET: List available content blocks

GET: See Content Blocks information

POST: Create content block

POST: Update content block

GET: List available email templates

GET: See email template information

POST: Create email template

POST: Update email template

GET: View all translations for a campaign

PUT: Update translation in a campaign

GET: View default source values for campaign translation tags

GET: View default source values for Content Block translation tags

GET: View all translations for a Content Block

PUT: Update translation in a Content Block

GET: View translation for a Canvas

PUT: Update translation in a Canvas

GET: View default source values for Canvas translation tags

GET: View source translations for email template

GET: View specific translation and locale for email template

GET: View all translations and locales for email template

PUT: Update translations for an email template

POST: Create new user alias

POST: Update user alias

POST: Identify users

POST: Create and update users

POST: Create and update users (bulk)

POST: Create and update users (synchronous)

POST: Delete users

POST: Merge users

External ID migration

POST: Rename external ID

POST: Remove external ID

Objects and filters

Canvas context object

Connected audience filter and object

Purchase object

Recipients object

Aliases to identify object

Trigger properties object

User alias object

User attributes object

Catalog selection object

Schedule object

Android objects

Content Card object

Kindle and FireOS push object

WhatsApp object

SCIM API objects and appendix

API identifier types

Errors and responses

Messaging Interaction Data

Postman and sample requests

API network connectivity issues

Transactional campaigns

Press Esc to close the menu

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

© Braze. All Rights Reserved
Privacy Policy