119 available actions
What your AI agent can do in Braze
Braze is a customer engagement platform for managing user data, messaging, campaigns, analytics, catalogs, templates, and workspace automation. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 119 actions.
Common starting points
- Get Custom Event AnalyticsGet 1 to 100 daily or hourly occurrence counts for one custom event, optionally filtered by app and analytics-enabled segment.
- Get Email TemplateReturn one stored HTML email template by API identifier.
- Create Email TemplatePersist an HTML email template on Braze's Templates & Media page.
- Create Message ScheduleHIGH IMPACT: schedule API-only channel messages for future processing.
- Update Email TemplatePersist one or more changes to an existing Braze email template by API identifier.
- Update Email Template TranslationsSubmit a durable update request with translation-tag string values for one email template locale.
Browse all 119 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 51 actions
- Export Global Control Group UsersStart an asynchronous export of all current Global Control Group users.
- Export Segment UsersStart an asynchronous newline-delimited JSON export for one segment.
- Export Users by IdentifiersReturn user profiles matching one or more Braze, external, alias, device, email, or phone identifiers; this reads profiles and does not track events or consume data…
- Get CampaignReturn configuration and delivery details for one campaign identified by its Braze campaign ID.
- Get Campaign AnalyticsGet up to 100 daily campaign analytics points.
- Get Campaign Translation SourceRead the default source values inside translation tags for one campaign message variation.
- Get CanvasReturn configuration and step details for one Canvas identified by its Braze Canvas ID.
- Get Canvas AnalyticsExport Canvas daily time-series analytics with optional variant, step, and deleted-step breakdowns.
- Get Canvas Analytics SummaryExport Canvas analytics rollups with optional variant, step, and deleted-step breakdowns.
- Get Canvas Translation SourceRead default source values inside translation tags for one Canvas step message variation.
- Get Catalog ItemReturn one Braze catalog item by exact catalog name and item ID.
- Get Content BlockReturn one persisted Braze Content Block by API identifier, optionally with its current campaign and Canvas inclusion records.
- Get Content Block Translation SourceRead default source values inside one Content Block's translation tags.
- Get Custom Event AnalyticsGet 1 to 100 daily or hourly occurrence counts for one custom event, optionally filtered by app and analytics-enabled segment.
- Get Email TemplateReturn one stored HTML email template by API identifier.
- Get Email Template Translation SourceRead default source values inside an email template's translation tags.
- Get Preference CenterGet persisted HTML, state, options, identifiers, and timestamps for one Braze preference center.
- Get Purchase SeriesGet 1 to 100 daily or hourly purchase quantity or revenue points, optionally filtered by app and product.
- Get SegmentReturn Braze's documented configuration details for one segment identified by its segment API identifier.
- Get Segment AnalyticsGet up to 100 daily estimated segment-size points.
- Get Send AnalyticsGet up to 100 daily analytics points for a tracked send from an API campaign.
- Get Session AnalyticsGet 1 to 100 daily or hourly session-count points, optionally filtered by app and analytics-enabled segment.
- Get Subscription Group StatusGet saved membership status for up to 50 users in one exact subscription group.
- Get User KPI SeriesGet 1 to 100 points for one user KPI: daily active users, rolling 30-day monthly active users, daily new users, or daily uninstalls.
- Get Webhook Template Translation SourceRead default source values inside a webhook template's translation tags.
- List CampaignsReturn one page of Braze campaigns for discovery, optionally including archived campaigns and filtering by last edit time.
- List Campaign TranslationsView every configured locale translation map for one campaign message variation, or filter by locale.
- List CanvasesReturn one fixed provider page of up to 100 Braze Canvases for discovery, optionally including archived Canvases and filtering by last edit time.
- List Canvas TranslationsPreview configured locale translations for one Canvas step message variation.
- List Catalog ItemsReturn one fixed provider page of up to 50 items from a Braze catalog, preserving arbitrary item attributes and exposing Braze Link-header pagination.
- List CatalogsReturn all catalogs in the connected Braze workspace.
- List Cloud Data Ingestion IntegrationsReturn one 10-item page of configured Cloud Data Ingestion integrations.
- List Cloud Data Ingestion Sync StatusesReturn one 10-item page of sync statuses for a Cloud Data Ingestion integration.
- List Content BlocksReturn one offset-based page of persisted Braze Content Blocks.
- List Content Block TranslationsView every configured locale translation map for one Content Block, or filter by locale.
- List Custom AttributesReturn one fixed provider page of up to 50 alphabetically sorted custom-attribute definitions and a Link-header continuation cursor.
- List Custom Event NamesReturn one fixed provider page of up to 250 alphabetically sorted custom event names.
- List Custom EventsReturn one fixed provider page of up to 50 alphabetically sorted custom-event definitions and a Link-header continuation cursor.
- List Email Template Locale TranslationsView email template translations, optionally filtered to one locale.
- List Email TemplatesReturn one offset-based page of stored HTML email templates.
- List Email Template TranslationsView all configured translations and locales for one email template.
- List Hard Bounced EmailsReturn one newest-first offset page of hard-bounced emails.
- List Invalid Phone NumbersReturn one newest-first offset page of invalid SMS numbers by UTC date range, or check exact E.164 numbers.
- List Preference CentersList all available Braze preference centers and their IDs and timestamps.
- List Purchase ProductsReturn every product ID from an optional caller-selected provider page.
- List Scheduled BroadcastsList dashboard and API scheduled campaigns and Canvas entries through an ISO 8601 end date.
- List SDK Authentication KeysHIGH IMPACT SECURITY READ: list all SDK Authentication public keys, IDs, descriptions, and primary status for one exact app.
- List SegmentsReturn one fixed provider page of up to 100 Braze segments and their IDs for audience discovery.
- List Unsubscribed EmailsReturn one offset page of latest unsubscribe records for a UTC date range or exact email.
- List User Subscription GroupsReturn one offset page of subscription groups that have status history for users selected by exactly one email or phone identifier type.
- List Webhook Template TranslationsView configured translations for one webhook template, optionally filtered by locale.
Create & communicateCreate records or send supported messagesView 21 actions
- Schedule Campaign TriggerHIGH IMPACT: schedule one durable API-triggered campaign dispatch.
- Schedule Canvas TriggerHIGH IMPACT: schedule one durable API-triggered Canvas entry.
- Create CatalogCreate one persistent catalog in the connected Braze workspace.
- Create Catalog FieldsAsynchronously create up to 50 fields in one Braze catalog.
- Create Catalog ItemSynchronously create one Braze catalog item by exact item ID.
- Create Multiple Catalog ItemsAsynchronously create up to 50 Braze catalog items.
- Create Catalog SelectionAsynchronously create one Braze catalog selection.
- Create Content BlockPersist a reusable HTML or text Content Block in the connected Braze workspace.
- Create Email TemplatePersist an HTML email template on Braze's Templates & Media page.
- Create Media Library AssetUpload one asset to Braze from a public HTTP(S) URL or local file.
- Create Message ScheduleHIGH IMPACT: schedule API-only channel messages for future processing.
- Create Preference CenterHIGH IMPACT: durably create and optionally activate a Braze-hosted preference center.
- Create SDK Authentication KeyHIGH IMPACT SECURITY OPERATION: create an SDK Authentication key from an RSA public key for one exact app.
- Create Send IDCreate or assign a send ID for programmatic message-performance tracking.
- Create User AliasesAdd up to 50 Braze aliases to existing external-ID users or create alias-only profiles.
- Generate Preference Center URLGenerate a user-specific URL for an API-created or drag-and-drop Braze preference center.
- Send Campaign TriggerHIGH IMPACT: immediately request an API-triggered campaign send.
- Send Canvas TriggerHIGH IMPACT: immediately request entry into an API-triggered Canvas.
- Send API-Only MessagesHIGH IMPACT: immediately request API-only messages to existing Braze users.
- Send Transactional CampaignHIGH IMPACT: send one immediate transactional email from a Braze Transactional Email campaign to exactly one external-ID or alias recipient; an accepted send cannot be…
- Create and Update UsersAsynchronously ingest Braze attributes, custom events, or purchases, up to 75 combined objects per portable request.
Update & manageChange and manage existing recordsView 25 actions
- Merge UsersAsynchronously merge up to 50 Braze source profiles into retained target profiles.
- Replace Catalog ItemSynchronously replace a Braze catalog item, creating it if item_id does not exist.
- Replace Multiple Catalog ItemsAsynchronously replace or create up to 50 Braze catalog items by id.
- Replace Media Library Asset FileHIGH IMPACT: request replacement of the file associated with one exact Braze media-library asset ID using a public HTTP(S) URL.
- Set Global Email Subscription StatusHIGH IMPACT: set the global email subscription state for one to 50 exact addresses, including addresses not yet attached to a profile.
- Set Primary SDK Authentication KeyHIGH IMPACT SECURITY OPERATION: make one exact existing SDK Authentication key the primary key for one exact app.
- Set Subscription Group StatusHIGH IMPACT: batch subscribe or unsubscribe up to 50 users in one exact group.
- Set Subscription Group StatusesHIGH IMPACT: batch subscribe or unsubscribe users across multiple groups.
- Start Live ActivityHIGH IMPACT: remotely request an iOS Live Activity start for exactly one target mode: up to 50 external users, one Connected Audience, or one segment.
- Update Campaign TranslationsSubmit a durable update request with translation-tag string values for one campaign message locale.
- Update Campaign Trigger ScheduleHIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered campaign.
- Update Canvas TranslationsSubmit a durable update request with translation-tag string values for one Canvas step message locale.
- Update Canvas Trigger ScheduleHIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered Canvas.
- Update Catalog ItemSynchronously patch one existing Braze catalog item.
- Update Multiple Catalog ItemsAsynchronously patch up to 50 existing Braze catalog items.
- Update Content BlockPersist changes to one existing Braze Content Block by API identifier.
- Update Content Block TranslationsSubmit a durable update request with translation-tag string values for one Content Block locale.
- Update Email TemplatePersist one or more changes to an existing Braze email template by API identifier.
- Update Email Template TranslationsSubmit a durable update request with translation-tag string values for one email template locale.
- Update Live ActivityUpdate an SDK-registered iOS Live Activity without ending it.
- Update Message ScheduleHIGH IMPACT: durably update the schedule, documented channel message objects, or both for an API-only scheduled message.
- Update Preference CenterHIGH IMPACT: durably update a Braze preference center's required page HTML and confirmation HTML, plus an optional title, state, or options configuration.
- Update Push CredentialsHIGH IMPACT: replace one app's push credentials for exactly one platform.
- Update User AliasesAsynchronously request renaming of up to 50 existing Braze aliases.
- Update Webhook Template TranslationsSubmit a durable update request with translation-tag string values for one webhook template locale.
Remove & cancelRemove records or cancel supported workView 15 actions
- Cancel Segment ExportsAsk Braze to cancel all ongoing exports for a segment.
- Delete Campaign Trigger ScheduleHIGH IMPACT: durably cancel a scheduled API-triggered campaign before send time.
- Delete Canvas Trigger ScheduleHIGH IMPACT: durably cancel a scheduled API-triggered Canvas before entry time.
- Delete CatalogPermanently delete one Braze catalog and all of its contents by exact catalog name through DELETE /catalogs/{catalog_name}.
- Delete Catalog FieldAsynchronously request deletion of one field by exact catalog and field name.
- Delete Catalog ItemRequest deletion of one catalog item by exact catalog name and item ID.
- Delete Multiple Catalog ItemsAsynchronously request deletion of up to 50 catalog items by exact IDs.
- Delete Catalog SelectionAsynchronously request deletion of a selection by exact catalog and selection name.
- Delete Message ScheduleHIGH IMPACT: durably cancel an API-only message schedule before it is sent.
- Delete SDK Authentication KeyHIGH IMPACT SECURITY OPERATION: permanently delete one exact non-primary SDK Authentication key from one exact app.
- Delete UsersPermanently queue deletion of up to 50 users using exactly one identifier type.
- Remove Deprecated External IDsPermanently remove up to 50 deprecated Braze external IDs.
- Remove Hard Bounced EmailsHIGH IMPACT: remove one to 50 exact addresses from both the Braze bounce list and the email provider's bounce list, potentially making them deliverable again.
- Remove Invalid Phone NumbersHIGH IMPACT: remove one to 50 exact E.164 numbers from Braze's invalid list so they can be revalidated and may receive SMS again.
- Remove Emails From Spam ListHIGH IMPACT: remove one to 50 exact addresses from both the Braze spam list and the email provider's spam list, potentially making them deliverable again.
Other actionsSpecialist and administrative actions.View 7 actions
- Blocklist EmailsHIGH IMPACT: globally unsubscribe and mark as hard bounced one to 50 exact email addresses.
- Duplicate CampaignHIGH IMPACT: request an asynchronous, durable duplicate of a Braze campaign.
- Duplicate CanvasHIGH IMPACT: request an asynchronous, durable duplicate of a Braze Canvas.
- End Live ActivityIRREVERSIBLE: end an SDK-registered iOS Live Activity with a final ContentState.
- Identify UsersAssign external IDs to alias-only, email-only, or phone-only Braze profiles, merging into an existing identified profile when applicable.
- Rename External IDsRename up to 50 primary Braze external IDs, preserving each old ID as deprecated.
- Trigger Cloud Data Ingestion SyncHIGH IMPACT: enqueue a sync for an existing Cloud Data Ingestion integration.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Braze
How does the agent connect to Braze?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Braze?
The page above lists the 119 actions currently available through the Braze connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Braze included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Braze is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Braze to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.