Braze

Start an asynchronous export of all current Global Control Group users. The response only acknowledges dispatch and identifies files; completion arrives through the callback, temporary URL, or configured cloud storage. Files are generally split per 5,000 users.

Untrusted display-only summary

Start an asynchronous newline-delimited JSON export for one segment. The response acknowledges dispatch, not completion. Only one export per segment may run at once, with at most 100 concurrent segment exports company-wide; event, purchase, campaign, and Canvas history fields contain 90 days of detail.

Untrusted display-only summary

Return 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 points.

Untrusted display-only summary

Generate a user-specific URL for an API-created or drag-and-drop Braze preference center. HIGH IMPACT: the returned URL is a sensitive capability that can change that user's subscriptions. Do not log, publish, or share it. This does not support legacy preference centers. Limited to 1,000 requests/minute per workspace.

Untrusted display-only summary

Return configuration and delivery details for one campaign identified by its Braze campaign ID.

Untrusted display-only summary

Get up to 100 daily campaign analytics points. Dashboard and Currents aggregation definitions can differ.

Untrusted display-only summary

Read the default source values inside translation tags for one campaign message variation. Requires campaigns.translations.get, translation tags on a multi-language message, and observes a 250,000 requests/minute limit.

Untrusted display-only summary

Return configuration and step details for one Canvas identified by its Braze Canvas ID.

Untrusted display-only summary

Export Canvas daily time-series analytics with optional variant, step, and deleted-step breakdowns. Dashboard and Currents definitions can differ.

Untrusted display-only summary

Export Canvas analytics rollups with optional variant, step, and deleted-step breakdowns. Braze normalizes range timestamps to midnight in the company time zone.

Untrusted display-only summary

Read default source values inside translation tags for one Canvas step message variation. Requires canvas.translations.get, translation tags on a multi-language message, and observes a 250,000 requests/minute limit.

Untrusted display-only summary

Return one Braze catalog item by exact catalog name and item ID. Requires the immutable catalogs.get_item API-key permission and shares a 50 requests/minute limit with synchronous catalog item endpoints.

Untrusted display-only summary

Return one persisted Braze Content Block by API identifier, optionally with its current campaign and Canvas inclusion records.

Untrusted display-only summary

Read default source values inside one Content Block's translation tags. Requires content_blocks.translations.get, configured translation tags, and observes a 250,000 requests/minute limit.

Untrusted display-only summary

Get 1 to 100 daily or hourly occurrence counts for one custom event, optionally filtered by app and analytics-enabled segment.

Untrusted display-only summary

Return one stored HTML email template by API identifier. Braze does not accept drag-and-drop-editor templates on this endpoint.

Untrusted display-only summary

Read default source values inside an email template's translation tags. This source endpoint specifically requires templates.email.info, plus a multi-language template, and observes a 250,000 requests/minute limit.

Untrusted display-only summary

Get persisted HTML, state, options, identifiers, and timestamps for one Braze preference center. Limited to 1,000 requests/minute per workspace.

Untrusted display-only summary

Get 1 to 100 daily or hourly purchase quantity or revenue points, optionally filtered by app and product. The selected metric determines the exact Braze purchase endpoint.

Untrusted display-only summary

Return Braze's documented configuration details for one segment identified by its segment API identifier.

Untrusted display-only summary

Get up to 100 daily estimated segment-size points. Export and count segment users when an exact size is required.

Untrusted display-only summary

Get up to 100 daily analytics points for a tracked send from an API campaign. Braze retains send analytics for 14 days after the send and attributes campaign conversions to the most recent send_id received by each user. Counts may not match dashboard analytics or Currents one-for-one because aggregation windows and de…

Untrusted display-only summary

Get 1 to 100 daily or hourly session-count points, optionally filtered by app and analytics-enabled segment.

Untrusted display-only summary

Get saved membership status for up to 50 users in one exact subscription group. External IDs take query precedence if also supplied; email and phone cannot be combined. Results are Subscribed, Unsubscribed, or Unknown and do not include the overriding global email state. Default rate limit: 250,000 requests/hour.

Untrusted display-only summary

Get 1 to 100 points for one user KPI: daily active users, rolling 30-day monthly active users, daily new users, or daily uninstalls. Optionally filter to one Braze app. The selected metric determines the exact Braze KPI endpoint.

Untrusted display-only summary

Read default source values inside a webhook template's translation tags. Requires templates.translations.get and webhook template translations enabled by Braze; otherwise Braze may return FEATURE_NOT_ENABLED. The endpoint has a 250,000 requests/minute limit.

Untrusted display-only summary

Assign external IDs to alias-only, email-only, or phone-only Braze profiles, merging into an existing identified profile when applicable. This is irreversible when a merge occurs: the source alias-only, email-only, or phone-only profile is removed after its data is transferred. Requires users.identify and shares a 20,…

Untrusted display-only summary

Return one page of Braze campaigns for discovery, optionally including archived campaigns and filtering by last edit time.

Untrusted display-only summary

View every configured locale translation map for one campaign message variation, or filter by locale. Requires campaigns.translations.get, multi-language support on the message, and observes a 250,000 requests/minute limit.

Untrusted display-only summary

Return one fixed provider page of up to 100 Braze Canvases for discovery, optionally including archived Canvases and filtering by last edit time. Braze exposes no page-size control; returning the complete page avoids losing continuation records. A local 10-item cap would save context tokens, not provider requests.

Untrusted display-only summary