Braze MCP server functions

The Braze MCP server exposes a set of API functions that map to specific Braze REST API endpoints. MCP clients like Claude and Cursor can call these functions to retrieve non-PII data and, with the right permissions, perform non-PII write actions. For more general information, see Braze MCP server.

important

Braze MCP server is in beta. You don’t need to request access to use it. Follow the setup instructions to get started. By using the Braze MCP server, you agree to the Braze Beta Terms. To help us make it better, send your feedback to [email protected].

Prerequisites

Before you can use this feature, you’ll need to set up the Braze MCP server.

Available Braze API functions

Your MCP client references the following API functions to interact with the Braze MCP server.

General functions

These functions help your MCP client discover and run the available Braze API functions.

Function	Description
`list_functions`	Lists all available Braze API functions with their descriptions and parameters.
`call_function`	Calls a specific read-only Braze API function with the provided parameters.
`call_write_function`	Calls a specific write-capable Braze API function with the provided parameters.

Campaigns

Function	Endpoint	Description
`get_campaign_list`	`/campaigns/list`	Export a list of campaigns with metadata.
`get_campaign_details`	`/campaigns/details`	Get detailed information about specific campaigns.
`get_campaign_dataseries`	`/campaigns/data_series`	Retrieve time series analytics data for campaigns.

Canvases

Function	Endpoint	Description
`get_canvas_list`	`/canvas/list`	Export a list of Canvases with metadata.
`get_canvas_details`	`/canvas/details`	Get detailed information about specific Canvases.
`get_canvas_data_summary`	`/canvas/data_summary`	Get summary analytics for Canvas performance.
`get_canvas_data_series`	`/canvas/data_series`	Retrieve time series analytics data for Canvases.

Catalogs

Function	Endpoint	Description
`get_catalogs`	`/catalogs`	Return a list of catalogs in a workspace.
`get_catalog_items`	`/catalogs/{catalog_name}/items`	Return multiple catalog items and their content with pagination support.
`get_catalog_item`	`/catalogs/{catalog_name}/items/{item_id}`	Return a specific catalog item and its content by ID.

Cloud Data Ingestion

Function	Endpoint	Description
`list_integrations`	`/cdi/integrations`	Return a list of existing CDI integrations.
`get_integration_job_sync_status`	`/cdi/integrations/{integration_id}/job_sync_status`	Return past sync statuses for a given CDI integration.

Content Blocks

The create_content_block and update_content_block functions are write functions. Your MCP client must call them with call_write_function, and your API key must have the matching content_blocks.create or content_blocks.update permission.

Function	Endpoint	Description
`get_content_blocks_list`	`/content_blocks/list`	List your available content blocks.
`get_content_blocks_info`	`/content_blocks/info`	Get information on your content blocks.
`create_content_block`	`/content_blocks/create`	Create a content block. Requires `name` and `content`. Optional fields are `description`, `state` (must be `active` or `draft`), and `tags`.
`update_content_block`	`/content_blocks/update`	Update an existing content block. Requires `content_block_id` and at least one updatable field: `name`, `content`, `description`, `state` (must be `active` or `draft`), or `tags`.

Custom Attributes

Function	Endpoint	Description
`get_custom_attributes`	`/custom_attributes`	Export custom attributes recorded for your app.

Events

Function	Endpoint	Description
`get_events_list`	`/events/list`	Export a list of custom events recorded for your app.
`get_events_data_series`	`/events/data_series`	Retrieve time series data for custom events.
`get_events`	`/events`	Get detailed event data with pagination support.

KPIs

Function	Endpoint	Description
`get_new_users_data_series`	`/kpi/new_users/data_series`	Daily series of new user counts.
`get_dau_data_series`	`/kpi/dau/data_series`	Daily Active Users time series data.
`get_mau_data_series`	`/kpi/mau/data_series`	Monthly Active Users time series data.
`get_uninstalls_data_series`	`/kpi/uninstalls/data_series`	App uninstall time series data.

Media Library

The create_media_library_asset function is a write function. Your MCP client must call it with call_write_function, and your API key must have the media_library.create permission.

Function	Endpoint	Description
`create_media_library_asset`	`/media_library/create`	Upload an asset to your Braze media library. You can provide either a publicly accessible URL (`asset_url`) or a base64-encoded file (`asset_file_base64`), but not both. Images have a 5 MB size limit.

Messages

Function	Endpoint	Description
`get_scheduled_broadcasts`	`/messages/scheduled_broadcasts`	List upcoming scheduled campaigns and Canvases.

Preference Centers

Function	Endpoint	Description
`get_preference_centers`	`/preference_center/v1/list`	List your available preference centers.
`get_preference_center_details`	`/preference_center/v1/{preferenceCenterExternalID}`	View details for a specific preference center including HTML content and options.

Purchases

Function	Endpoint	Description
`get_product_list`	`/purchases/product_list`	Export paginated list of product IDs.
`get_revenue_series`	`/purchases/revenue_series`	Revenue analytics time series data.
`get_quantity_series`	`/purchases/quantity_series`	Purchase quantity time series data.

Segments

Function	Endpoint	Description
`get_segment_list`	`/segments/list`	Export list of segments with analytics tracking status.
`get_segment_data_series`	`/segments/data_series`	Time series analytics data for segments.
`get_segment_details`	`/segments/details`	Detailed information about specific segments.

Sends

Function	Endpoint	Description
`get_send_data_series`	`/sends/data_series`	Daily analytics for tracked campaign sends.

Sessions

Function	Endpoint	Description
`get_session_data_series`	`/sessions/data_series`	Time series data for app session counts.

SDK Authentication Keys

Function	Endpoint	Description
`get_sdk_authentication_keys`	`/app_group/sdk_authentication/keys`	List all SDK Authentication keys for your app.

Subscription

Function	Endpoint	Description
`get_user_subscription_groups`	`/subscription/user/status`	List and get the subscription groups of a certain user.
`get_subscription_group_status`	`/subscription/status/get`	Get the subscription state of a user in a subscription group.

Templates

The create_email_template and update_email_template functions are write functions. Your MCP client must call them with call_write_function, and your API key must have the matching templates.email.create or templates.email.update permission.

Function	Endpoint	Description
`get_email_templates_list`	`/templates/email/list`	List your available email templates.
`get_email_template_info`	`/templates/email/info`	Get information on your email templates.
`create_email_template`	`/templates/email/create`	Create an email template. Requires `template_name`, `subject`, and `body`. Optional fields are `plaintext_body`, `preheader`, `tags`, and `should_inline_css`.
`update_email_template`	`/templates/email/update`	Update an existing email template. Requires `email_template_id` and at least one updatable field: `template_name`, `subject`, `body`, `plaintext_body`, `preheader`, `tags`, or `should_inline_css`.

Disclaimer

The Model Context Protocol (MCP) is a newly introduced open-source protocol that may be susceptible to security issues or vulnerabilities at this time.

Braze MCP Server setup code and instructions are provided by Braze “as is” and without any warranties, and customers use it at their own risk. Braze shall not be responsible for any consequences arising from improper setup, misuse of the MCP, or any potential security issues that may arise. Braze strongly encourages customers to review their configurations carefully and to follow the outlined guidelines to reduce risks associated with the integrity and security of their Braze environment.

For assistance or clarification, please contact Braze Support.

New Stuff!