Action

Description

Required scopes

List Campaigns

Export list of campaigns with names and API identifiers

Get Campaign Details

Retrieve relevant information about a specific campaign

List Canvas

Export list of Canvas workflows with names and API identifiers

Get Canvas Details

Get details for a specific Canvas workflow

Get Canvas Analytics

Get analytics data series for a specific Canvas workflow

Get Canvas Summary

Get analytics summary for a specific Canvas workflow

Track Users

Record custom events, purchases, and update user profile attributes

Export Users By Identifier

Export user profile data by user identifier

Delete Users

Delete user profiles (permanent, cannot be undone)

Identify Users

Identify unidentified (alias-only) users with external ID

Merge Users

Merge one user profile into another user profile

Create User Alias

Create new user aliases for existing users

Rename External IDs

Rename users' external IDs

Remove Deprecated External IDs

Remove deprecated external IDs from user profiles

Update User Alias

Update existing user aliases

List Catalogs

Return list of catalogs in a workspace

Create Catalog

Create a new product catalog

Get Catalog Item

Return a catalog item and its content

Create Catalog Item

Create an item in a catalog

Update Catalog Item

Update an item in your catalog or create if not found

Delete Catalog Item

Delete an item in your catalog

Delete Catalog

Delete a catalog

Edit Catalog Item

Edit an item in your catalog

List Catalog Items

Return multiple catalog items and their content

Create Catalog Items Bulk

Create multiple items in your catalog (max 50 items)

Update Catalog Items Bulk

Update multiple items or create if not found (max 50 items)

Edit Catalog Items Bulk

Edit multiple items in your catalog (max 50 items)

Delete Catalog Items Bulk

Delete multiple items in your catalog (max 50 items)

Create Catalog Fields

Create new fields for a catalog

Delete Catalog Field

Delete a field from a catalog

List Segments

Export list of segments with names and API identifiers

Get Segment Details

Retrieve relevant information about a specific segment

List Email Templates

Get list of available email templates

List Content Blocks

List available Content Blocks

Get Email Template

Get information about a specific email template

Create Email Template

Create email templates on the Braze dashboard

Update Email Template

Update email templates on the Braze dashboard

Get Content Block

Get information about a specific content block

Create Content Block

Create a new content block on the Braze dashboard

Update Content Block

Update an existing content block on the Braze dashboard

List Custom Events

Export list of custom events

List Products

Export list of products purchased in your app

Get KPI - Daily Active Users

Retrieve series of total daily active users over time

Get KPI - Monthly Active Users

Retrieve series of total monthly active users over time

Get KPI - New Users

Retrieve series of new users per day

Get Campaign Analytics

Retrieve campaign analytics data over time

Get Segment Analytics

Retrieve daily series of estimated segment size over time

Get Custom Events Analytics

Retrieve series of occurrences of a custom event over time

Get Purchases Analytics

Retrieve total number of purchases over time

Get Revenue Analytics

Retrieve total revenue over time

Get Sessions Analytics

Retrieve series of number of sessions over time

Get KPI - Uninstalls

Retrieve series of total uninstalls over time

Export Users By Segment

Export user data for a specific segment

Export Users Global Control Group

Export user data for the global control group

List Custom Attributes

Export list of custom attributes

Get Send Analytics

Retrieve analytics for a specific campaign send

List User Subscription Groups

List and get subscription groups of a user

Get User Subscription Group Status

Get the subscription state of a user in a subscription group

Update User Subscription Group Status

Update the subscription state of a user in a subscription group

Update User Subscription Group Status V2

Update the subscription state of a user in a subscription group (V2)

Query Hard Bounced Emails

Pull a list of email addresses that have hard bounced

Query Unsubscribed Emails

Return emails that have unsubscribed during the time period

Change Email Subscription Status

Set the email subscription state for your users

Remove Hard Bounced Emails

Remove email addresses from the hard bounce list

Send Messages

Send immediate, one-off messages to designated users via API

List Scheduled Messages

View upcoming scheduled campaigns and Canvases

Schedule Messages

Schedule messages to be sent at a designated time

Update Scheduled Messages

Update scheduled messages that were created in the dashboard

Delete Scheduled Messages

Cancel scheduled messages that were created via API

Send Transactional Message

Send transactional messages via a triggered campaign

Send Triggered Campaign

Send API-triggered campaign messages

Send Triggered Canvas

Send API-triggered Canvas messages

Create Send ID

Create a send ID for message send tracking

Schedule Triggered Campaign

Schedule an API-triggered campaign for future delivery

Schedule Triggered Canvas

Schedule an API-triggered Canvas for future delivery

Update Scheduled Triggered Campaign

Update a scheduled API-triggered campaign

Update Scheduled Triggered Canvas

Update a scheduled API-triggered Canvas

Delete Scheduled Triggered Campaign

Delete a scheduled API-triggered campaign

Delete Scheduled Triggered Canvas

Delete a scheduled API-triggered Canvas

Update Live Activity

Update an iOS Live Activity via push notification

Query Invalid Phone Numbers

Pull a list of invalid phone numbers. Requires either phone\_numbers OR both start\_date AND end\_date together — Braze rej...

Remove Invalid Phone Numbers

Remove invalid phone numbers from blocklist

List Preference Centers

List available preference centers

Get Preference Center

Get details of a specific preference center

Create Preference Center

Create a new preference center

Update Preference Center

Update an existing preference center

Create Preference Center URL

Create URL for a preference center for a specific user

List CDI Integrations

Return list of existing integrations

Trigger CDI Sync

Trigger a sync for a CDI integration

Get CDI Job Sync Status

Return the sync status for a CDI integration

View Campaign Translations

View bulk translations for a specific campaign

Update Campaign Translations

Update translations for a specific campaign

View Canvas Translations

View bulk translations for a specific Canvas

Update Canvas Translations

Update translations for a specific Canvas

View Email Template Translations

View bulk translations for a specific email template

Update Email Template Translations

Update translations for a specific email template

View Content Block Translations

View bulk translations for a specific content block

Update Content Block Translations

Update translations for a specific content block