Connectors

Marketing & Customer Engagement

Braze

Customer engagement: user profiles, campaigns, canvases, and message sending
Braze API referenceAPI checked August 20, 2026
Signs in with
API token
Runs on
Cloud or On-Prem Worker
Operations
95
Ready-made triggers
0

Connect Braze

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Braze and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
REST endpoint host (e.g. rest.iad-01.braze.com)Required
API keyRequiredSecret

Use it in a flow

  1. Open a flow, open the node library and search for Braze.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from Braze without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Braze can send webhooks, a Webhook trigger receives them at its own URL.

Operations

95 operations in 25 groups. Each one is a step you can add to a flow.

Catalogs > Catalog Items > Asynchronous4
Create multiple catalog itemspostcatalogs_catalog_name_itemsPOSTUse this endpoint to create multiple items in your catalog.
Delete multiple catalog itemsdeletecatalogs_catalog_name_itemsDELETEUse this endpoint to delete multiple items in your catalog.
Edit multiple catalog itemspatchcatalogs_catalog_name_itemsPATCHUse this endpoint to delete multiple items in your catalog.
Update multiple catalog itemsputcatalogs_catalog_name_itemsPUTUse this endpoint to update multiple items in your catalog.
Catalogs > Catalog Items > Synchronous6
Create catalog itempostcatalogs_catalog_name_items_item_idPOSTUse this endpoint to create an item in your catalog.
Delete a catalog itemdeletecatalogs_catalog_name_items_item_idDELETEUse this endpoint to delete an item in your catalog.
Edit catalog itemspatchcatalogs_catalog_name_items_item_idPATCHUse this endpoint to edit an item in your catalog.
List catalog item detailsgetcatalogs_catalog_name_items_item_idGETUse this endpoint to return a catalog item and its content.
List multiple catalog item detailsgetcatalogs_catalog_name_itemsGETUse this endpoint to return multiple catalog items and their content.
Update catalog itemputcatalogs_catalog_name_items_item_idPUTUse this endpoint to update an item in your catalog.
Catalogs > Catalog Management > Synchronous3
Create catalogpostcatalogsPOSTUse this endpoint to create a catalog.
Delete catalogdeletecatalogs_catalog_nameDELETEUse this endpoint to delete a catalog.
List catalogsgetcatalogsGETUse this endpoint to return a list of catalogs in a workspace.
Email Lists & Address7
Blacklist email addressespostemail_blacklistPOSTUse this endpoint to unsubscribe a user from email and mark them as hard bounced.
Blocklist email addressespostemail_blocklistPOSTUse this endpoint to unsubscribe a user from email and mark them as hard bounced.
Change email subscription statuspostemail_statusPOSTUse this endpoint to set the email subscription state for your users.
Query hard bounced emailsgetemail_hard_bouncesGETUse this endpoint to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame.
Query list of unsubscribed email addressesgetemail_unsubscribesGETUse this endpoint to return emails that have unsubscribed during the time period from start date to end date.
Remove email addresses from spam listpostemail_spam_removePOSTUse this endpoint to remove email addresses from your Braze spam list and spam list maintained by your email provider.
Remove hard bounced emailspostemail_bounce_removePOSTUse this endpoint to remove email addresses from your Braze bounce list and bounce list maintained by your email provider.
Export > Campaign4
Export campaign analyticsgetcampaigns_data_seriesGETUse this endpoint to retrieve a daily series of various stats for a campaign over time.
Export campaign detailsgetcampaigns_detailsGETUse this endpoint to retrieve relevant information on a specified campaign, which can be identified by the campaign id.
Export campaign listgetcampaigns_listGETUse this endpoint to export a list of campaigns, each of which will include its name, campaign API identifier, whether it is an API campaign, and tags associated with the campaign.
Export send analyticsgetsends_data_seriesGETUse this endpoint to retrieve a daily series of various stats for a tracked send id for API campaigns.
Export > Canva4
Export Canvas data analytics summarygetcanvas_data_summaryGETUse this endpoint to export rollups of time series data for a Canvas, providing a concise summary of a Canvas’ results.
Export Canvas data series analyticsgetcanvas_data_seriesGETUse this endpoint to export time series data for a Canvas.
Export Canvas detailsgetcanvas_detailsGETUse this endpoint to export metadata about a Canvas, such as the name, time created, current status, and more.
Export Canvas listgetcanvas_listGETUse this endpoint to export a list of Canvases, including the name, Canvas API identifier and associated tags.
Export > Custom Event2
Export custom events analyticsgetevents_data_seriesGETUse this endpoint to retrieve a series of the number of occurrences of a custom event in your app over a designated time period.
Export custom events listgetevents_listGETUse this endpoint to export a list of custom events that have been recorded for your app.
Export > KPI4
Export daily active users by dategetkpi_dau_data_seriesGETUse this endpoint to retrieve a daily series of the total number of unique active users on each date.
Export daily new users by dategetkpi_new_users_data_seriesGETUse this endpoint to retrieve a daily series of the total number of new users on each date.
Export KPIs for daily app uninstalls by dategetkpi_uninstalls_data_seriesGETUse this endpoint to retrieve a daily series of the total number of uninstalls on each date.
Export monthly active users for last 30 daysgetkpi_mau_data_seriesGETUse this endpoint to retrieve a daily series of the total number of unique active users over a 30-day rolling window.
Export > News Feed3
Export News Feed Card analyticsgetfeed_data_seriesGETUse this endpoint to retrieve a daily series of engagement stats for a card over time.
Export News Feed Cards detailsgetfeed_detailsGETUse this endpoint to retrieve relevant information on a card, which can be identified by the card id.
Export News Feed Cards listgetfeed_listGETUse this endpoint to export a list of News Feed cards, each of which will include its name and card API identifier.
Export > Purchase3
Export number of purchasesgetpurchases_quantity_seriesGETUse this endpoint to return the total number of purchases in your app over a time range.
Export product IDsgetpurchases_product_listGETUse this endpoint to return a paginated lists of product IDs.
Export revenue data by timegetpurchases_revenue_seriesGETUse this endpoint to return the total money spent in your app over a time range.
Export > Segment3
Export segment analyticsgetsegments_data_seriesGETUse this endpoint to retrieve a daily series of the estimated size of a segment over time.
Export segment detailsgetsegments_detailsGETUse this endpoint to retrieve relevant information on a segment, which can be identified by the segment id.
Export segment listgetsegments_listGETUse this endpoint to export a list of segments, each of which will include its name, Segment API identifier, and whether it has analytics tracking enabled.
Export > Session Analytic1
Export app sessions by timegetsessions_data_seriesGETUse this endpoint to retrieve a series of the number of sessions for your app over a designated time period.
Export > User Data3
Export user profile by Global Control Grouppostusers_export_global_control_groupPOSTUse this endpoint to export all users within a Global Control Group.
Export user profile by identifierpostusers_export_idsPOSTUse this endpoint to export data from any user profile by specifying a user identifier.
Export user profile by segmentpostusers_export_segmentPOSTUse this endpoint to export all the users within a segment.
Messages > Live Activity1
Update Live Activitypostmessages_live_activity_updatePOSTUse this endpoint to update and end Live Activities displayed by your iOS app.
Messages > Schedule Mesage10
Create scheduled messagespostmessages_schedule_createPOSTUse this endpoint to schedule a campaign, Canvas, or other message to be sent at a designated time and provides you with an identifier to reference that message for updates.
Delete scheduled API-triggered campaignspostcampaigns_trigger_schedule_deletePOSTThe delete schedule endpoint allows you to cancel a message that you previously scheduled API-triggered Canvases before it has been sent.
Delete scheduled API-triggered Canvasespostcanvas_trigger_schedule_deletePOSTUse this endpoint to cancel a Canvas message that you previously scheduled via API-triggered before it has been sent.
Delete scheduled messagespostmessages_schedule_deletePOSTUse this endpoint to cancel a message that you previously scheduled before it has been sent.
List upcoming scheduled campaigns and Canvasesgetmessages_scheduled_broadcastsGETUse this endpoint to return a JSON list of information about scheduled campaigns and entry Canvases between now and a designated end time specified in the request.
Schedule API-triggered campaignspostcampaigns_trigger_schedule_createPOSTUse this endpoint to send dashboard created campaign messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent.
Schedule API-triggered Canvasespostcanvas_trigger_schedule_createPOSTUse this endpoint to schedule Canvas messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent.
Update scheduled API-triggered campaignspostcampaigns_trigger_schedule_updatePOSTUse this endpoint to update scheduled API-triggered campaigns created in the dashboard, allowing you to decide what action should trigger the message to be sent.
Update scheduled API-triggered Canvasespostcanvas_trigger_schedule_updatePOSTUse this endpoint to update scheduled API-triggered Canvases that were created in the dashboard.
Update scheduled messagespostmessages_schedule_updatePOSTUse this endpoint to update scheduled messages.
Messages > Send Message5
Create send IDspostsends_id_createPOSTUse this endpoint to create send IDs that can be used to send messages and track message performance programatically, without campaign creation for each send.
Send campaigns using API-triggered deliverypostcampaigns_trigger_sendPOSTUse this endpoint to send immediate, ad-hoc messages to designated users via API-triggered delivery.
Send Canvases using API-triggered deliverypostcanvas_trigger_sendPOSTUse this endpoint to send Canvas messages via API-triggered delivery.
Send messages immediately using the API onlypostmessages_sendPOSTUse this endpoint to send immediate messages to designated users via the Braze API.
Send Transactional Email using API-triggered deliveryposttransactional_v1_campaigns_campaign_id_sendPOSTUse this endpoint to send immediate, one-off transactional messages to a designated user.
Preference Center5
Create preference centerpostpreference_center_v1POSTUse this endpoint to create a preference center to allow users to manage their notification preferences for your email campaigns.
Generate preference center URLgetpreference_center_v1_PreferenceCenterExternalID_url_UserIDGETUse this endpoint to generate a URL for a preference center.
List preference centersgetpreference_center_v1_listGETUse this endpoint to list your available preference centers.
Update preference centerputpreference_center_v1_PreferenceCenterExternalIDPUTUse this endpoint to update a preference center.
View details for preference centergetpreference_center_v1_PreferenceCenterExternalIDGETUse this endpoint to view the details for your preference centers, including when it was created and updated.
SCIM5
Create new dashboard user accountpostscim_v2_UsersPOSTUse this endpoint to create a new dashboard user account by specifying email, given and family names, permissions (for setting permissions at the company, app group, and team level).
Look up an existing dashboard user accountgetscim_v2_Users_idGETUse this endpoint to look up an existing dashboard user account by specifying the resource id returned by the SCIM <code>POST</code> method.
Remove dashboard user accountdeletescim_v2_Users_idDELETEUse this endpoint to permanently delete an existing dashboard user by specifying the resource id returned by the SCIM <code>POST</code> method.
Search existing dashboard user by emailgetscim_v2_UsersGETUse this endpoint to look up an existing dashboard user account by specifying their email in the filter query parameter.
Update dashboard user accountputscim_v2_Users_idPUTUse this endpoint to update an existing dashboard user account by specifying the resource id returned by the SCIM <code>POST</code> method.
SMS2
Query invalid phone numbersgetsms_invalid_phone_numbersGETUse this endpoint to pull a list of phone numbers that have been deemed “invalid” within a certain time frame.
Remove invalid phone numberspostsms_invalid_phone_numbers_removePOSTUse this endpoint to remove “invalid” phone numbers from Braze’s invalid list.
Subscription Groups > Email2
List user's subscription groupgetsubscription_user_statusGETUse this endpoint to list and get the subscription groups of a certain user.
List user's subscription group statusgetsubscription_status_getGETUse this endpoint to get the subscription state of a user in a subscription group.
Subscription Groups > SMS And WhatsApp2
Update user's subscription group statuspostsubscription_status_setPOSTUse this endpoint to batch update the subscription state of up to 50 users on the Braze dashboard.
Update user's subscription group status (V2)postv2_subscription_status_setPOSTUse this endpoint to batch update the subscription state of up to 50 users on the Braze dashboard.
Templates > Content Block4
Create Content Blockpostcontent_blocks_createPOSTUse this endpoint to create a Content Block.
List available Content Blocksgetcontent_blocks_listGETUse this endpoint to list your existing Content Blocks information.
See Content Block informationgetcontent_blocks_infoGETUse this endpoint to call information for your existing Content Blocks.
Update Content Blockpostcontent_blocks_updatePOSTUse this endpoint to update a Content Block.
Templates > Email Template4
Create email templateposttemplates_email_createPOSTUse this endpoint to create email templates on the Braze dashboard.
List available email templatesgettemplates_email_listGETUse this endpoint to get a list of available templates in your Braze account.
See email template informationgettemplates_email_infoGETUse this endpoint to get information on your email templates.
Update email templateposttemplates_email_updatePOSTUse this endpoint to update email templates on the Braze dashboard.
User Data6
Create new user aliaspostusers_alias_newPOSTUse this endpoint to add new user aliases for existing identified users, or to create new unidentified users.
Delete userspostusers_deletePOSTUse this endpoint to delete any user profile by specifying a known user identifier.
Identify userspostusers_identifyPOSTUse this endpoint to identify an unidentified (alias-only or email-only) user using the provided external ID.
Merge userspostusers_mergePOSTUse this endpoint to merge one user into another user.
Track userspostusers_trackPOSTUse this endpoint to record custom events, purchases, and update user profile attributes.
Update user aliaspostusers_alias_updatePOSTUse this endpoint to update existing user aliases.
User Data > External ID Migration2
Remove external IDpostusers_external_ids_removePOSTUse this endpoint to remove your users' old deprecated external IDs.
Rename external IDpostusers_external_ids_renamePOSTUse this endpoint to rename your users’ external IDs.