Braze website screenshot

Braze

Braze is a leading customer engagement platform providing REST APIs for managing user profiles, orchestrating multi-channel messaging campaigns, and exporting analytics. The platform supports email, SMS, push notifications, in-app messages, and content cards across mobile and web channels. Braze uses Bearer token authentication with region-specific REST endpoints and offers extensive webhook and Canvas automation capabilities for lifecycle marketing.

Braze publishes 24 APIs on the APIs.io network, including Catalogs > Catalog Items > Asynchronous API, Catalogs > Catalog Items > Synchronous API, Catalogs > Catalog Management > Synchronous API, and 21 more. Tagged areas include Customer Engagement, Marketing Automation, Messaging, Push Notifications, and Email.

The Braze catalog on APIs.io includes 1 event-driven AsyncAPI specification.

Braze’s developer surface includes authentication, documentation, support, changelog, FAQ, engineering blog, API reference, and 43 more developer resources.

🌐 Visit website 📡 Source on GitHub
81.6/100 exemplar ▬ flat Agent 49/100 agent ready Full breakdown ↓
scored 2026-08-20 · rubric v0.12.0
AccessPaid
24 APIs 1 MCP Servers 16 Features
Customer EngagementMarketing AutomationMessagingPush NotificationsEmailSMSMobile

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-20 · rubric v0.12.0
Composite quality — 81.6/100 · exemplar
Contract Quality 14.9 / 21
Developer Ergonomics 11.2 / 17
Access Clarity 17.0 / 17
Operational Transparency 10.2 / 11
Contract Governance 1.7 / 10
Discoverability 7.9 / 9
Regulatory Posture 12.1 / 15
Agent readiness — 49/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 0 / 10
Documented Reversibility 0 / 6
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 3 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Regulatory Posture applies to this provider. Its tags matched the Telecommunications regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
The six quality facets above are damped to 85 points between them, because the conditional facet above carries the other 15. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 85% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/braze: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 24

Individual APIs this provider publishes, each with its own machine-readable definition.

Braze Catalogs > Catalog Items > Asynchronous API

The Catalogs > Catalog Items > Asynchronous API from Braze — 1 operation(s) for catalogs > catalog items > asynchronous.

Braze Catalogs > Catalog Items > Synchronous API

The Catalogs > Catalog Items > Synchronous API from Braze — 2 operation(s) for catalogs > catalog items > synchronous.

Braze Catalogs > Catalog Management > Synchronous API

The Catalogs > Catalog Management > Synchronous API from Braze — 2 operation(s) for catalogs > catalog management > synchronous.

Braze Email Lists & Addresses API

Users email subscription status can be updated and retrieved via Braze using a RESTful API. You can use the API to set up bi-directional sync between Braze and other email syste...

Braze Export > Campaign API

The Export > Campaign API from Braze — 4 operation(s) for export > campaign.

Braze Export > Canvas API

The Export > Canvas API from Braze — 4 operation(s) for export > canvas.

Braze Export > Custom Events API

The Export > Custom Events API from Braze — 2 operation(s) for export > custom events.

Braze Export > KPI API

The Export > KPI API from Braze — 4 operation(s) for export > kpi.

Braze Export > News Feed API

The Export > News Feed API from Braze — 3 operation(s) for export > news feed.

Braze Export > Purchases API

The Export > Purchases API from Braze — 3 operation(s) for export > purchases.

Braze Export > Segment API

The Export > Segment API from Braze — 3 operation(s) for export > segment.

Braze Export > Session Analytics API

The Export > Session Analytics API from Braze — 1 operation(s) for export > session analytics.

Braze Export > Users API

The Export > Users API from Braze — 3 operation(s) for export > users.

Braze Messaging > Live Activities API

The Messaging > Live Activities API from Braze — 1 operation(s) for messaging > live activities.

Braze Messaging > Schedule Mesages API

The Messaging > Schedule Mesages API from Braze — 10 operation(s) for messaging > schedule mesages.

Braze Messaging > Send Messages API

The Messaging > Send Messages API from Braze — 5 operation(s) for messaging > send messages.

Braze Preference Center API

The Preference Center API from Braze — 4 operation(s) for preference center.

Braze SCIM API

The SCIM API from Braze — 2 operation(s) for scim.

Braze SMS API

Use the Braze SMS Endpoints to manage your users phone numbers in your subscription groups.

Braze Subscription Groups > SMS and WhatsApp API

The Subscription Groups > SMS and WhatsApp API from Braze — 4 operation(s) for subscription groups > sms and whatsapp.

Braze Templates > Content Blocks API

Content Blocks are an Email Templating feature that allow you to: - Create a consistent look and feel to your Email campaigns using Content Blocks as Headers and Footers. - Dist...

Braze Templates > Email Templates API

The Templates > Email Templates API from Braze — 4 operation(s) for templates > email templates.

Braze User Data API

The User API allows you to track information on your users by logging data about your users that comes from outside your mobile app. You can also use this API to delete users fo...

Braze User Data > External ID Migration API

The External ID Migration API allows you to rename existing external IDs (creating a new primary ID and deprecating the existing ID) and remove deprecated IDs post-migration.

Scroll for all 24

Open Collections 25

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

API Collection

OPEN COLLECTION

Braze Catalogs > Catalog Items > Asynchronous API

OPEN COLLECTION

Braze Catalogs > Catalog Items > Synchronous API

OPEN COLLECTION

Braze Catalogs > Catalog Management > Synchronous API

OPEN COLLECTION

Braze Email Lists & Addresses API

OPEN COLLECTION

Braze Export > Campaign API

OPEN COLLECTION

Braze Export > Canvas API

OPEN COLLECTION

Braze Export > Custom Events API

OPEN COLLECTION

Braze Export > KPI API

OPEN COLLECTION

Braze Export > News Feed API

OPEN COLLECTION

Braze Export > Purchases API

OPEN COLLECTION

Braze Export > Segment API

OPEN COLLECTION

Braze Export > Session Analytics API

OPEN COLLECTION

Braze Export > Users API

OPEN COLLECTION

Braze Messaging > Live Activities API

OPEN COLLECTION

Braze Messaging > Schedule Mesages API

OPEN COLLECTION

Braze Messaging > Send Messages API

OPEN COLLECTION

Braze Preference Center API

OPEN COLLECTION

Braze SCIM API

OPEN COLLECTION

Braze SMS API

OPEN COLLECTION

Braze Subscription Groups > SMS and WhatsApp API

OPEN COLLECTION

Braze Templates > Content Blocks API

OPEN COLLECTION

Braze Templates > Email Templates API

OPEN COLLECTION

Braze User Data API

OPEN COLLECTION

Braze User Data > External ID Migration API

OPEN COLLECTION

Scroll for all 25

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

Braze MCP Server

MCP SERVER

GraphQL 1

GraphQL schemas published by this provider.

Braze GraphQL Schema

This is a conceptual GraphQL schema for the Braze customer engagement platform. Braze exposes a REST API; this GraphQL schema is a normalized representation of the data models, ...

GRAPHQL

Pricing Plans 1

Published pricing tiers and plan structures.

Braze Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Braze Rate Limits

22 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Braze Finops

FINOPS

Features 16

Notable capabilities this provider offers.

Custom pricing based on MAU + channels + AI usage
Mid-market: $60K-$200K/year typical
Enterprise: $1M+/year for large deployments
Platform Editions: Core, Pro, Enterprise
Channels: Email, Push, In-App, Content Cards, SMS, WhatsApp, Webhooks
REST API at rest.iad-XX.braze.com (region-specific)
/users/track: 50,000 req/min/workspace
/messages/send: 250 req/min/workspace
/transactional/send: 250 req/sec/workspace
Canvas Flow for advanced journey orchestration
Predictive AI for churn / conversion likelihood
Sage AI Copilot for marketers
Audience Sync to ad platforms
Data residency in US/EU/AU regions
SCIM/SSO on Enterprise
Webhooks for journey triggers

Scroll for all 16

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Braze Webhooks

ASYNCAPI

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Braze Authentication

http/oauth2 · 3 schemes

SECURITY

Braze Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Braze Vulnerability Disclosure

Hackerone · security.txt · contact published

SECURITY

Braze Trust Center

ISO 27001, SOC 2 Type 2, TISAX, HIPAA

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Braze Scopes

2 scopes · authorizationCode

2 scopes

SCOPES

Resources

Get Started 4

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 SignUp
SignUp
 Login
Login

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

LlmsText
LlmsText
 MCPServer
MCPServer
 WellKnown
WellKnown
 LLMsTxt
LLMsTxt
 AgentSkill
AgentSkill

Design & Contract 7

Pagination, idempotency, versioning, errors, and events

Conformance
Conformance
 ErrorCatalog
ErrorCatalog
 Lifecycle
Lifecycle
 Conventions
Conventions
 Components
Components
 DataModel
DataModel
 Webhooks
Webhooks

Scroll for all 7

Build 5

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 ToolCrosswalk
ToolCrosswalk
 Packages
Packages
 SDKs
SDKs
 Postman
Postman

Access & Security 8

Authentication, authorization, and security posture

Authentication
Authentication
 VulnerabilityDisclosure
VulnerabilityDisclosure
 DomainSecurity
DomainSecurity
 SecurityTxt
SecurityTxt
 OAuthScopes
OAuthScopes
 Compliance
Compliance
 TrustCenter
TrustCenter
 Security
Security

Scroll for all 8

Learn 2

Tutorials, courses, talks, and written guidance

Videos
Videos
 Webinars
Webinars

Operate 8

Status, limits, changes, and where to get help

Support
Support
 ChangeLog
ChangeLog
 FAQ
FAQ
 RateLimits
RateLimits
 StatusPage
StatusPage
 Deprecation
Deprecation
 ChangeLog
ChangeLog
 RateLimits
RateLimits

Scroll for all 8

Commercial 4

Pricing, plans, and the legal terms of use

PrivacyPolicy
PrivacyPolicy
 Plans
Plans
 Pricing
Pricing
 TermsOfService
TermsOfService

Company 4

The organization behind the API

LinkedIn
LinkedIn
 Website
Website
 Partners
Partners
 Blog
Blog

Other 1

Properties that don't map to a standard resource type

CaseStudies
CaseStudies

Source (apis.yml)

apis.yml Raw ↑ 
aid: braze
url: https://raw.githubusercontent.com/api-evangelist/braze/refs/heads/main/apis.yml
name: Braze
tags:
- Customer Engagement
- Marketing Automation
- Messaging
- Push Notifications
- Email
- SMS
- Mobile
type: Index
kind: company
accessModel:
  pricing: paid
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Paid
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/braze.png
access: 3rd-Party
created: '2025-02-06'
modified: '2026-08-13'
position: Consumer
description: Braze is a leading customer engagement platform providing REST APIs for managing user profiles, orchestrating
  multi-channel messaging campaigns, and exporting analytics. The platform supports email, SMS, push notifications, in-app
  messages, and content cards across mobile and web channels. Braze uses Bearer token authentication with region-specific
  REST endpoints and offers extensive webhook and Canvas automation capabilities for lifecycle marketing.
apis:
- aid: braze:braze-catalogs-catalog-items-asynchronous-api
  name: Braze Catalogs > Catalog Items > Asynchronous API
  description: The Catalogs > Catalog Items > Asynchronous API from Braze — 1 operation(s) for catalogs > catalog items >
    asynchronous.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Catalogs > Catalog Items > Asynchronous
  properties:
  - type: OpenAPI
    url: openapi/braze-catalogs-catalog-items-asynchronous-api-openapi.yml
  - type: Overlay
    url: overlays/braze-catalogs-catalog-items-asynchronous-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-catalogs-catalog-items-synchronous-api
  name: Braze Catalogs > Catalog Items > Synchronous API
  description: The Catalogs > Catalog Items > Synchronous API from Braze — 2 operation(s) for catalogs > catalog items > synchronous.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Catalogs > Catalog Items > Synchronous
  properties:
  - type: OpenAPI
    url: openapi/braze-catalogs-catalog-items-synchronous-api-openapi.yml
  - type: Overlay
    url: overlays/braze-catalogs-catalog-items-synchronous-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-catalogs-catalog-management-synchronous-api
  name: Braze Catalogs > Catalog Management > Synchronous API
  description: The Catalogs > Catalog Management > Synchronous API from Braze — 2 operation(s) for catalogs > catalog management
    > synchronous.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Catalogs > Catalog Management > Synchronous
  properties:
  - type: OpenAPI
    url: openapi/braze-catalogs-catalog-management-synchronous-api-openapi.yml
  - type: Overlay
    url: overlays/braze-catalogs-catalog-management-synchronous-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-email-lists-addresses-api
  name: Braze Email Lists & Addresses API
  description: Users email subscription status can be updated and retrieved via Braze using a RESTful API. You can use the
    API to set up bi-directional sync between Braze and other email systems or your own database.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Email Lists & Addresses
  properties:
  - type: OpenAPI
    url: openapi/braze-email-lists-addresses-api-openapi.yml
  - type: Overlay
    url: overlays/braze-email-lists-addresses-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-campaign-api
  name: Braze Export > Campaign API
  description: The Export > Campaign API from Braze — 4 operation(s) for export > campaign.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Campaign
  properties:
  - type: OpenAPI
    url: openapi/braze-export-campaign-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-campaign-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-canvas-api
  name: Braze Export > Canvas API
  description: The Export > Canvas API from Braze — 4 operation(s) for export > canvas.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Canvas
  properties:
  - type: OpenAPI
    url: openapi/braze-export-canvas-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-canvas-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-custom-events-api
  name: Braze Export > Custom Events API
  description: The Export > Custom Events API from Braze — 2 operation(s) for export > custom events.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Custom Events
  properties:
  - type: OpenAPI
    url: openapi/braze-export-custom-events-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-custom-events-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-kpi-api
  name: Braze Export > KPI API
  description: The Export > KPI API from Braze — 4 operation(s) for export > kpi.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > KPI
  properties:
  - type: OpenAPI
    url: openapi/braze-export-kpi-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-kpi-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-news-feed-api
  name: Braze Export > News Feed API
  description: The Export > News Feed API from Braze — 3 operation(s) for export > news feed.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > News Feed
  properties:
  - type: OpenAPI
    url: openapi/braze-export-news-feed-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-news-feed-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-purchases-api
  name: Braze Export > Purchases API
  description: The Export > Purchases API from Braze — 3 operation(s) for export > purchases.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Purchases
  properties:
  - type: OpenAPI
    url: openapi/braze-export-purchases-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-purchases-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-segment-api
  name: Braze Export > Segment API
  description: The Export > Segment API from Braze — 3 operation(s) for export > segment.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Segment
  properties:
  - type: OpenAPI
    url: openapi/braze-export-segment-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-segment-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-session-analytics-api
  name: Braze Export > Session Analytics API
  description: The Export > Session Analytics API from Braze — 1 operation(s) for export > session analytics.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Session Analytics
  properties:
  - type: OpenAPI
    url: openapi/braze-export-session-analytics-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-session-analytics-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-export-users-api
  name: Braze Export > Users API
  description: The Export > Users API from Braze — 3 operation(s) for export > users.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Export > Users
  properties:
  - type: OpenAPI
    url: openapi/braze-export-users-api-openapi.yml
  - type: Overlay
    url: overlays/braze-export-users-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-messaging-live-activities-api
  name: Braze Messaging > Live Activities API
  description: The Messaging > Live Activities API from Braze — 1 operation(s) for messaging > live activities.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Messaging > Live Activities
  properties:
  - type: OpenAPI
    url: openapi/braze-messaging-live-activities-api-openapi.yml
  - type: Overlay
    url: overlays/braze-messaging-live-activities-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-messaging-schedule-mesages-api
  name: Braze Messaging > Schedule Mesages API
  description: The Messaging > Schedule Mesages API from Braze — 10 operation(s) for messaging > schedule mesages.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Messaging > Schedule Mesages
  properties:
  - type: OpenAPI
    url: openapi/braze-messaging-schedule-mesages-api-openapi.yml
  - type: Overlay
    url: overlays/braze-messaging-schedule-mesages-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-messaging-send-messages-api
  name: Braze Messaging > Send Messages API
  description: The Messaging > Send Messages API from Braze — 5 operation(s) for messaging > send messages.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Messaging > Send Messages
  properties:
  - type: OpenAPI
    url: openapi/braze-messaging-send-messages-api-openapi.yml
  - type: Overlay
    url: overlays/braze-messaging-send-messages-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-preference-center-api
  name: Braze Preference Center API
  description: The Preference Center API from Braze — 4 operation(s) for preference center.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Preference Center
  properties:
  - type: OpenAPI
    url: openapi/braze-preference-center-api-openapi.yml
  - type: Overlay
    url: overlays/braze-preference-center-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-scim-api
  name: Braze SCIM API
  description: The SCIM API from Braze — 2 operation(s) for scim.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - SCIM
  properties:
  - type: OpenAPI
    url: openapi/braze-scim-api-openapi.yml
  - type: Overlay
    url: overlays/braze-scim-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-sms-api
  name: Braze SMS API
  description: Use the Braze SMS Endpoints to manage your users phone numbers in your subscription groups.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - SMS
  properties:
  - type: OpenAPI
    url: openapi/braze-sms-api-openapi.yml
  - type: Overlay
    url: overlays/braze-sms-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-subscription-groups-sms-and-whatsapp-api
  name: Braze Subscription Groups > SMS and WhatsApp API
  description: The Subscription Groups > SMS and WhatsApp API from Braze — 4 operation(s) for subscription groups > sms and
    whatsapp.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Subscription Groups > SMS and WhatsApp
  properties:
  - type: OpenAPI
    url: openapi/braze-subscription-groups-sms-and-whatsapp-api-openapi.yml
  - type: Overlay
    url: overlays/braze-subscription-groups-sms-and-whatsapp-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-templates-content-blocks-api
  name: Braze Templates > Content Blocks API
  description: "Content Blocks are an Email Templating feature that allow you to: \n- Create a consistent look and feel to\
    \ your Email campaigns using Content Blocks as Headers and Footers.\n- Distribute the same offer codes through different\
    \ channels.\n- Create pre-defined assets that can be used to build messages with consistent information and assets.\n\
    - Copy entire message bodies to other messages.\n\nYou can edit Content Blocks in the Templates & Media section of the\
    \ Braze UI, or here, via API."
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Templates > Content Blocks
  properties:
  - type: OpenAPI
    url: openapi/braze-templates-content-blocks-api-openapi.yml
  - type: Overlay
    url: overlays/braze-templates-content-blocks-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-templates-email-templates-api
  name: Braze Templates > Email Templates API
  description: The Templates > Email Templates API from Braze — 4 operation(s) for templates > email templates.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - Templates > Email Templates
  properties:
  - type: OpenAPI
    url: openapi/braze-templates-email-templates-api-openapi.yml
  - type: Overlay
    url: overlays/braze-templates-email-templates-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-user-data-api
  name: Braze User Data API
  description: 'The User API allows you to track information on your users by logging data about your users that comes from
    outside your mobile app. You can also use this API to delete users for testing or other purposes.


    All API endpoints have a data payload limit of 4MB. Attempts to post more data than 4MB will fail with an HTTP 413 Request
    Entity Too Large.


    The examples below contain the URL https://rest.iad-01.braze.com, but some customers will need to use a different endpoint
    URL, for example if you are hosted in Brazes EU data center or have a dedicated Braze installation. Your Success Manager
    will inform you if you should use a different endpoint URL.'
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - User Data
  properties:
  - type: OpenAPI
    url: openapi/braze-user-data-api-openapi.yml
  - type: Overlay
    url: overlays/braze-user-data-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
- aid: braze:braze-user-data-external-id-migration-api
  name: Braze User Data > External ID Migration API
  description: The External ID Migration API allows you to rename existing external IDs (creating a new primary ID and deprecating
    the existing ID) and remove deprecated IDs post-migration. <br><br> We've architected this solution to allow multiple
    External IDs in order to support a migration period whereby older versions of your apps still in the wild that use the
    previous External ID naming schema dont break. We highly recommend removing deprecated External IDs once your old naming
    schema is no longer in use.
  humanURL: https://www.braze.com/docs/api/basics/
  baseURL: https://rest.iad-01.braze.com
  tags:
  - User Data > External ID Migration
  properties:
  - type: OpenAPI
    url: openapi/braze-user-data-external-id-migration-api-openapi.yml
  - type: Overlay
    url: overlays/braze-user-data-external-id-migration-overlay.yaml
  - type: Documentation
    url: https://www.braze.com/docs/api/basics/
  - type: GraphQL
    url: graphql/braze-graphql.md
common:
- type: Authentication
  url: authentication/braze-authentication.yml
- type: VulnerabilityDisclosure
  url: security/braze-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/braze-domain-security.yml
- type: GitHubOrganization
  url: https://github.com/braze-inc
- type: LinkedIn
  url: https://www.linkedin.com/company/braze
- type: Website
  url: https://www.braze.com
- type: Documentation
  url: https://www.braze.com/docs
- type: Partners
  url: https://www.braze.com/docs/partners/home
- type: Support
  url: https://www.braze.com/docs/help/home
- type: ChangeLog
  url: https://www.braze.com/docs/help/release_notes
- type: FAQ
  url: https://www.braze.com/docs/help/faqs
- type: RateLimits
  url: https://www.braze.com/docs/api/api_limits
- type: UseCases
  url: https://www.braze.com/docs/api/use_cases
- type: PrivacyPolicy
  url: https://www.braze.com/docs/user_guide/privacy_portal
- type: Blog
  url: https://www.braze.com/resources/articles
- type: Videos
  url: https://www.braze.com/resources/videos
- type: CaseStudies
  url: https://www.braze.com/customers
- type: Webinars
  url: https://www.braze.com/resources/webinars-and-events
- type: Features
  data:
  - Custom pricing based on MAU + channels + AI usage
  - 'Mid-market: $60K-$200K/year typical'
  - 'Enterprise: $1M+/year for large deployments'
  - 'Platform Editions: Core, Pro, Enterprise'
  - 'Channels: Email, Push, In-App, Content Cards, SMS, WhatsApp, Webhooks'
  - REST API at rest.iad-XX.braze.com (region-specific)
  - '/users/track: 50,000 req/min/workspace'
  - '/messages/send: 250 req/min/workspace'
  - '/transactional/send: 250 req/sec/workspace'
  - Canvas Flow for advanced journey orchestration
  - Predictive AI for churn / conversion likelihood
  - Sage AI Copilot for marketers
  - Audience Sync to ad platforms
  - Data residency in US/EU/AU regions
  - SCIM/SSO on Enterprise
  - Webhooks for journey triggers
  sources:
  - https://www.braze.com/pricing
  updated: '2026-05-04'
- type: Integrations
  url: https://www.braze.com/partners
- type: LlmsText
  url: https://braze.com/llms.txt
- type: MCPServer
  url: mcp/braze-mcp.yml
- type: ToolCrosswalk
  url: mcp/braze-tool-crosswalk.yml
- type: Packages
  url: packages/braze-packages.yml
- type: SDKs
  url: packages/braze-packages.yml
- type: WellKnown
  url: well-known/braze-well-known.yml
- type: SecurityTxt
  url: well-known/braze-security.txt
- type: LLMsTxt
  url: llms/braze-llms.txt
- type: OAuthScopes
  url: scopes/braze-scopes.yml
- type: Conformance
  url: conformance/braze-conformance.yml
- type: Compliance
  url: https://www.braze.com/docs/developer_guide/disclosures/security_qualifications
- type: TrustCenter
  url: security/braze-trust-center.yml
- type: Security
  url: https://hackerone.com/braze_inc
- type: ErrorCatalog
  url: errors/braze-problem-types.yml
- type: Lifecycle
  url: lifecycle/braze-lifecycle.yml
- type: StatusPage
  url: https://status.braze.com
- type: Deprecation
  url: https://www.braze.com/docs/releases/deprecations
- type: Conventions
  url: conventions/braze-conventions.yml
- type: ChangeLog
  url: changelog/braze-changelog.yml
- type: Components
  url: components/braze-components.yml
- type: DataModel
  url: data-model/braze-data-model.yml
- type: Webhooks
  url: asyncapi/braze-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Plans
  url: plans/braze-plans-pricing.yml
- type: RateLimits
  url: rate-limits/braze-rate-limits.yml
- type: DeveloperPortal
  url: https://www.braze.com/docs/developer_guide/home
- type: APIReference
  url: https://www.braze.com/docs/api/basics/
- type: GettingStarted
  url: https://www.braze.com/docs/developer_guide/sdk_integration/
- type: Pricing
  url: https://www.braze.com/pricing
- type: SignUp
  url: https://www.braze.com/get-started/
- type: Login
  url: https://dashboard.braze.com/sign_in
- type: TermsOfService
  url: https://www.braze.com/company/legal/terms/
- type: Postman
  url: https://www.postman.com/braze-inc/braze-public-workspace
integrations:
- name: Become a Partner
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com
specificationVersion: '0.23'
x-enrichment:
  date: '2026-08-13'
  status: enriched
  artifacts_added: 48
  pass: local-v1