Articles in this section

Available Braze APIs

When you configure an export, import, or other type of flow step using the prebuilt Braze connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Braze API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API Endpoint

Export

Import

Catalog: Catalog selections

Create catalog selection

X

Delete catalog selection

X

Catalogs: Catalog fields

Create catalog fields

X

Delete catalog field

X

Delete multiple catalog items

X

Edit multiple catalog items

X

Create multiple catalog items

X

Update multiple catalog items

X

List multiple catalog item details

X

Delete a catalog item

X

List catalog item details

X

Edit catalog items

X

Create catalog item

X

Update catalog item

X

Catalogs: Catalog management

Delete catalog

X

List catalogs

X

Create catalog

X

Cloud data ingestion

List integrations

X

List job sync status

X

Trigger a sync

X

Email lists and addresses

Query hard bounced emails

X

Query list of unsubscribed email addresses

X

Change email subscription status

X

Remove hard bounced emails

X

Remove email addresses from spam list

X

Blocklist email addresses

X

Blacklist email addresses

X

Export: Campaign

Export campaign analytics

X

Export campaign details

X

Export campaign list

X

Export send analytics

X

Export: Canvas

Export canvas data series analytics

X

Export canvas data analytics summary

X

Export canvas details

X

Export canvas list

X

Export: Custom attributes

Export custom attributes

X

Export: Custom events

Export custom events list

X

Export custom events analytics

X

Export: KPI

Export daily new users by date

X

Export daily active users by date

X

Export monthly active users for last 30 days

X

Export KPIs for daily app uninstalls by date

X

Export: News feed

Export news feed card analytics

X

Export news feed cards details

X

Export news feed cards list

X

Export: Purchases

Export product IDs

X

Export number of purchases

X

Export revenue data by time

X

Export: Segment

Export segment list

X

Export segment analytics

X

Export segment details

X

Export: Session analytics

Export app sessions by time

X

Export: User data

Export user profile by identifier

X

Export user profile by segment

X

Export user profile by global control group

X

Messages: Duplicate messages

Duplicate campaigns

X

Duplicate canvases

X

Messages: Live activities

Update live activity

X

Messages: Schedule messages

List upcoming scheduled campaigns and canvases

X

Delete scheduled messages

X

Delete scheduled API triggered canvases

X

Delete scheduled API triggered campaigns

X

Create scheduled messages

X

Schedule API triggered campaigns

X

Schedule API triggered canvases

X

Update scheduled messages

X

Update scheduled API triggered campaigns

X

Update scheduled API triggered canvases

X

Messages: Send messages

Create send IDs

X

Send messages immediately using the API only

X

Send transactional email using API triggered delivery

X

Send campaigns using API triggered delivery

X

Send canvases using API triggered delivery

X

Preference center

Generate preference center URL

X

List preference centers

X

View details for preference center

X

Update preference center

X

Create preference center

X

SCIM

Remove dashboard user account

X

Look up an existing dashboard user account

X

Update dashboard user account

X

Search existing dashboard user by email

X

Create new dashboard user account

X

SMS

Query invalid phone numbers

X

Remove invalid phone numbers

X

Subscription groups: Email

List user's subscription group status

X

List user's subscription group

X

Update user's subscription group status (V2)

X

Update user's subscription group status

X

Subscription groups: SMS and WhatsApp

List user's subscription group status

X

List user's subscription group

X

Update user's subscription group status (V2)

X

Update user's subscription group status

X

Templates: Content blocks

List available content blocks

X

See content block information

X

Create content block

X

Update content block

X

Templates: Email templates

List available email templates

X

See email template information

X

Create email template

X

Update email template

X

Translations: Campaigns

View all translations for a campaign

X

View translation for a campaign

X

Update translation in a campaign

X

Translations: Canvas

View all translations for a canvas

X

View translation for a canvas

X

Update translation in a canvas

X

Translations: Email templates

View the source translations for an email template

X

View a specific translation and locale for email template

X

View all translations and locales for an email template

X

Update translations for an email template

X

User data

Rename external ID

X

Remove external ID

X

Create new user alias

X

Update user alias

X

Identify users

X

Track users

X

Delete users

X

Merge users

X

Track users (synchronous)

X