Braze
Braze is a customer engagement platform for managing user data, messaging, campaigns, analytics, catalogs, templates, and workspace automation.
119 actionsAPI key
What your bot can do in Braze
Looks up
- 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.
- Generate Preference Center URLGenerate a user-specific URL for an API-created or drag-and-drop Braze preference center.
- 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.
Show 42 more
- 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.
- Get Webhook Template Translation SourceRead default source values inside a webhook template's translation tags.
- List Campaign TranslationsView every configured locale translation map for one campaign message variation, or filter by locale.
- List CampaignsReturn one page of Braze campaigns for discovery, optionally including archived campaigns and filtering by last edit time.
- List Canvas TranslationsPreview configured locale translations for one Canvas step message variation.
- List CanvasesReturn one fixed provider page of up to 100 Braze Canvases for discovery, optionally including archived Canvases and filtering by last…
- 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…
- 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 Block TranslationsView every configured locale translation map for one Content Block, or filter by locale.
- List Content BlocksReturn one offset-based page of persisted Braze Content Blocks.
- 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 Template TranslationsView all configured translations and locales for one email template.
- List Email TemplatesReturn one offset-based page of stored HTML email templates.
- 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 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.
Takes action
- Blocklist EmailsHIGH IMPACT.
- Cancel Segment ExportsAsk Braze to cancel all ongoing exports for a segment.
- Create and Update UsersAsynchronously ingest Braze attributes, custom events, or purchases, up to 75 combined objects per portable request.
- 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 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.
Show 57 more
- Create Message ScheduleHIGH IMPACT.
- Create Multiple Catalog ItemsAsynchronously create up to 50 Braze catalog items.
- Create Preference CenterHIGH IMPACT.
- Create SDK Authentication KeyHIGH IMPACT SECURITY OPERATION.
- 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.
- Delete Campaign Trigger ScheduleHIGH IMPACT.
- Delete Canvas Trigger ScheduleHIGH IMPACT.
- 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 Catalog SelectionAsynchronously request deletion of a selection by exact catalog and selection name.
- Delete Message ScheduleHIGH IMPACT.
- Delete Multiple Catalog ItemsAsynchronously request deletion of up to 50 catalog items by exact IDs.
- Delete SDK Authentication KeyHIGH IMPACT SECURITY OPERATION.
- Delete UsersPermanently queue deletion of up to 50 users using exactly one identifier type.
- Duplicate CampaignHIGH IMPACT.
- Duplicate CanvasHIGH IMPACT.
- End Live ActivityIRREVERSIBLE.
- Identify UsersAssign external IDs to alias-only, email-only, or phone-only Braze profiles, merging into an existing identified profile when applicable.
- Merge UsersAsynchronously merge up to 50 Braze source profiles into retained target profiles.
- Remove Deprecated External IDsPermanently remove up to 50 deprecated Braze external IDs.
- Remove Emails From Spam ListHIGH IMPACT.
- Remove Hard Bounced EmailsHIGH IMPACT.
- Remove Invalid Phone NumbersHIGH IMPACT.
- Rename External IDsRename up to 50 primary Braze external IDs, preserving each old ID as deprecated.
- Replace Catalog ItemSynchronously replace a Braze catalog item, creating it if item_id does not exist.
- Replace Media Library Asset FileHIGH IMPACT.
- Replace Multiple Catalog ItemsAsynchronously replace or create up to 50 Braze catalog items by id.
- Schedule Campaign TriggerHIGH IMPACT.
- Schedule Canvas TriggerHIGH IMPACT.
- Send API-Only MessagesHIGH IMPACT.
- Send Campaign TriggerHIGH IMPACT.
- Send Canvas TriggerHIGH IMPACT.
- Send Transactional CampaignHIGH IMPACT.
- Set Global Email Subscription StatusHIGH IMPACT.
- Set Primary SDK Authentication KeyHIGH IMPACT SECURITY OPERATION.
- Set Subscription Group StatusHIGH IMPACT.
- Set Subscription Group StatusesHIGH IMPACT.
- Start Live ActivityHIGH IMPACT.
- Trigger Cloud Data Ingestion SyncHIGH IMPACT.
- Update Campaign TranslationsSubmit a durable update request with translation-tag string values for one campaign message locale.
- Update Campaign Trigger ScheduleHIGH IMPACT.
- Update Canvas TranslationsSubmit a durable update request with translation-tag string values for one Canvas step message locale.
- Update Canvas Trigger ScheduleHIGH IMPACT.
- Update Catalog ItemSynchronously patch one existing Braze catalog item.
- 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.
- Update Multiple Catalog ItemsAsynchronously patch up to 50 existing Braze catalog items.
- Update Preference CenterHIGH IMPACT.
- Update Push CredentialsHIGH IMPACT.
- 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.