- Category: marketing automation
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 119
- Triggers: 0
- Slug:
BRAZE - Version: 20261101_00
Tools
Blocklist Emails
Blocklist Emails
BRAZE_BLOCKLIST_EMAILSHIGH IMPACT: globally unsubscribe and mark as hard bounced one to 50 exact email addresses. This can affect every profile sharing an address and prevent delivery across campaigns. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Cancel Segment Exports
Cancel Segment Exports
Schedule Campaign Trigger
Schedule Campaign Trigger
BRAZE_CREATE_CAMPAIGN_TRIGGER_SCHEDULEHIGH IMPACT: schedule an API-triggered campaign for up to 50 recipients or a broadcast audience; recipient attributes can create or update profiles. Recipients can be intersected with a Connected Audience; audience-only targeting requires broadcast, recipient properties override shared keys, and acceptance does not prove delivery.Input Parameters
Output
Schedule Canvas Trigger
Schedule Canvas Trigger
BRAZE_CREATE_CANVAS_TRIGGER_SCHEDULESchedule an API-triggered Canvas entry for up to 50 recipients, optionally intersected with a Connected Audience, or broadcast to an audience; recipient attributes can create or update profiles before the trigger. Per-recipient context overrides shared context; requires canvas.trigger.schedule.create, and acceptance is not delivery.Input Parameters
Output
Create Catalog
Create Catalog
BRAZE_CREATE_CATALOGCreate one persistent catalog in the connected Braze workspace. The catalog name must be unique and identifies the resource for later reads or deletion.Input Parameters
Output
Create Catalog Fields
Create Catalog Fields
BRAZE_CREATE_CATALOG_FIELDSAsynchronously create up to 50 fields in one Braze catalog. Requires the immutable catalogs.create_fields API-key permission and shares a 50 requests/minute limit with asynchronous catalog field and selection endpoints. A 202 response only confirms acceptance; Braze documents no job ID or terminal result.Input Parameters
Output
Create Catalog Item
Create Catalog Item
BRAZE_CREATE_CATALOG_ITEMSynchronously create one Braze catalog item by exact item ID. Requires the immutable catalogs.create_item API-key permission and shares a 50 requests/minute synchronous item limit. Existing IDs and body-level id fields are rejected.Input Parameters
Output
Create Multiple Catalog Items
Create Multiple Catalog Items
BRAZE_CREATE_CATALOG_ITEMSAsynchronously create up to 50 Braze catalog items. Requires the immutable catalogs.add_items API-key permission and shares a 16,000 requests/minute limit with asynchronous catalog item endpoints. A 202 response confirms acceptance only; Braze documents no job ID, per-item result, or terminal completion.Input Parameters
Output
Create Catalog Selection
Create Catalog Selection
BRAZE_CREATE_CATALOG_SELECTIONAsynchronously create one Braze catalog selection using scalar filters, requiring the catalogs.create_selection API-key permission and sharing a 50 requests/minute limit with asynchronous field and selection endpoints. Storage and selection-count gates may reject the request; a 202 response confirms acceptance only, not completion.Input Parameters
Output
Create Content Block
Create Content Block
BRAZE_CREATE_CONTENT_BLOCKPersist a reusable HTML or text Content Block in the connected Braze workspace. This creates content only; it does not send or deliver a message.Input Parameters
Output
Create Email Template
Create Email Template
Create Media Library Asset
Create Media Library Asset
BRAZE_CREATE_MEDIA_LIBRARY_ASSETUpload one asset to Braze from a public HTTP(S) URL or local file. URL mode sends JSON; local-file mode uses the multipart asset_file contract implemented by Braze’s official MCP server and does not send base64. Images, vectors, and documents are limited to 5 MB; ZIP files are limited to 50 MB total and 5 MB per supported root-level file. Videos and VCF files are dashboard-only. Media Library Public APIs must be enabled; free-trial workspaces have a default 200-asset limit. Rate limit: 100/hour.Input Parameters
Output
Create Message Schedule
Create Message Schedule
BRAZE_CREATE_MESSAGE_SCHEDULEHIGH IMPACT: schedule API-only channel messages for future processing. Individual targets are limited to 50 combined IDs and aliases; otherwise explicit broadcast=true is required. Requires messages.schedule.create. The returned schedule and dispatch IDs confirm acceptance only and never delivery; rendered payload size, subscription state, and channel eligibility remain gates.Input Parameters
Output
Create Preference Center
Create Preference Center
BRAZE_CREATE_PREFERENCE_CENTERHIGH IMPACT: durably create and optionally activate a Braze-hosted preference center. Its name cannot be changed after creation. Confirm HTML, state, and identifiers before calling. Limited to 10 requests/minute per workspace; Braze publishes no separate plan-tier gate.Input Parameters
Output
Create SDK Authentication Key
Create SDK Authentication Key
BRAZE_CREATE_SDK_AUTHENTICATION_KEYHIGH IMPACT SECURITY OPERATION: create an SDK Authentication key from an RSA public key for one exact app. Set make_primary only when the new key should immediately replace the current primary key. Never submit private-key material. Braze permits at most three keys per app. Success is rejected unless Braze returns a new key ID. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Create Send ID
Create Send ID
BRAZE_CREATE_SEND_IDCreate or assign a send ID for programmatic message-performance tracking. Every explicit campaign_id and send_id combination counts toward the workspace limit of 100 custom send IDs/day. Requires sends.id.create; this action creates tracking identity and does not send a message.Input Parameters
Output
Create User Aliases
Create User Aliases
BRAZE_CREATE_USER_ALIASESAdd up to 50 Braze aliases to existing external-ID users or create alias-only profiles. Requires users.alias.new. Duplicate alias-label/name pairs can return success without changing a profile; a 201-style success is acceptance, not proof that every alias was attached. Shares a 20,000 requests/minute rate limit.Input Parameters
Output
Delete Campaign Trigger Schedule
Delete Campaign Trigger Schedule
BRAZE_DELETE_CAMPAIGN_TRIGGER_SCHEDULEHIGH IMPACT: durably cancel a scheduled API-triggered campaign before send time. This cannot undo sends already processed. Last-second cancellation is best-effort and may affect all, some, or none of the target users. Requires campaigns.trigger.schedule.delete; an accepted response is not proof that no sends occurred.Input Parameters
Output
Delete Canvas Trigger Schedule
Delete Canvas Trigger Schedule
BRAZE_DELETE_CANVAS_TRIGGER_SCHEDULEHIGH IMPACT: durably cancel a scheduled API-triggered Canvas before entry time. This cannot undo entries already processed. Last-second cancellation is best-effort and may affect all, some, or none of the target users. Requires canvas.trigger.schedule.delete; acceptance is not proof that no Canvas entries occurred.Input Parameters
Output
Delete Catalog
Delete Catalog
BRAZE_DELETE_CATALOGPermanently delete one Braze catalog and all of its contents by exact catalog name through DELETE /catalogs/{catalog_name}. This cannot be undone and requires catalogs.delete permission.Input Parameters
Output
Delete Catalog Field
Delete Catalog Field
BRAZE_DELETE_CATALOG_FIELDAsynchronously request deletion of one field by exact catalog and field name. Requires the immutable catalogs.delete_fields API-key permission and shares a 50 requests/minute field/selection limit. Fields used by a selection or as an inventory field cannot be deleted. A 202 response is acceptance, not completion.Input Parameters
Output
Delete Catalog Item
Delete Catalog Item
BRAZE_DELETE_CATALOG_ITEMRequest deletion of one catalog item by exact catalog name and item ID. HTTP 202 with message=success confirms acceptance, not terminal deletion. Requires the immutable catalogs.delete_item API-key permission and shares a 50 requests/minute synchronous item limit.Input Parameters
Output
Delete Multiple Catalog Items
Delete Multiple Catalog Items
BRAZE_DELETE_CATALOG_ITEMSAsynchronously request deletion of up to 50 catalog items by exact IDs. Requires the immutable catalogs.delete_items API-key permission and shares a 16,000 requests/minute asynchronous item limit. A 202 response is only request acceptance; Braze returns no documented job ID or per-item deletion proof.Input Parameters
Output
Delete Catalog Selection
Delete Catalog Selection
BRAZE_DELETE_CATALOG_SELECTIONAsynchronously request deletion of a selection by exact catalog and selection name. Requires the immutable catalogs.delete_selection API-key permission and shares a 50 requests/minute field/selection limit. A 202 response confirms acceptance only; Braze documents no terminal deletion result.Input Parameters
Output
Delete Message Schedule
Delete Message Schedule
Delete SDK Authentication Key
Delete SDK Authentication Key
BRAZE_DELETE_SDK_AUTHENTICATION_KEYHIGH IMPACT SECURITY OPERATION: permanently delete one exact non-primary SDK Authentication key from one exact app. Braze refuses deletion of the primary key; select another primary first. Success is rejected unless the returned remaining-key list excludes the exact requested key ID. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Delete Users
Delete Users
BRAZE_DELETE_USERSPermanently queue deletion of up to 50 users using exactly one identifier type. Requires users.delete and shares a 20,000 requests/minute rate limit. This cannot be undone; success reports queued count, not completion, and cache propagation can take up to five minutes.Input Parameters
Output
Duplicate Campaign
Duplicate Campaign
BRAZE_DUPLICATE_CAMPAIGNHIGH IMPACT: request an asynchronous, durable duplicate of a Braze campaign. The duplicate persists until explicitly deleted and can consume workspace campaign capacity. HTTP 202 confirms only that Braze accepted the request, not that campaign creation completed. Existing tags only; a supplied tag list replaces source tags. Requires campaigns.duplicate and is limited to 100 calls/minute.Input Parameters
Output
Duplicate Canvas
Duplicate Canvas
BRAZE_DUPLICATE_CANVASHIGH IMPACT: request an asynchronous, durable duplicate of a Braze Canvas. The duplicate persists until explicitly deleted and can consume workspace Canvas capacity. HTTP 202 confirms only acceptance, not completed Canvas creation. Existing tags only; a supplied tag list replaces source tags. Requires canvas.duplicate and is limited to 100 calls/minute.Input Parameters
Output
End Live Activity
End Live Activity
BRAZE_END_LIVE_ACTIVITYIRREVERSIBLE: end an SDK-registered iOS Live Activity with a final ContentState. An optional past dismissal_date removes it from the UI immediately. Requires messages.live_activity.update. HTTP 201 confirms receipt only, not APNs dispatch, display, dismissal, or delivery. An ended activity cannot be resumed.Input Parameters
Output
Export Global Control Group Users
Export Global Control Group Users
BRAZE_EXPORT_GLOBAL_CONTROL_GROUP_USERSStart 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.Input Parameters
Output
Export Segment Users
Export Segment Users
BRAZE_EXPORT_SEGMENT_USERSStart 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.Input Parameters
Output
Export Users by Identifiers
Export Users by Identifiers
BRAZE_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 points.Input Parameters
Output
Generate Preference Center URL
Generate Preference Center URL
BRAZE_GENERATE_PREFERENCE_CENTER_URLGenerate 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.Input Parameters
Output
Get Campaign
Get Campaign
BRAZE_GET_CAMPAIGNReturn configuration and delivery details for one campaign identified by its Braze campaign ID.Input Parameters
Output
Get Campaign Analytics
Get Campaign Analytics
Get Campaign Translation Source
Get Campaign Translation Source
Get Canvas
Get Canvas
BRAZE_GET_CANVASReturn configuration and step details for one Canvas identified by its Braze Canvas ID.Input Parameters
Output
Get Canvas Analytics
Get Canvas Analytics
Get Canvas Analytics Summary
Get Canvas Analytics Summary
Get Canvas Translation Source
Get Canvas Translation Source
Get Catalog Item
Get Catalog Item
Get Content Block
Get Content Block
BRAZE_GET_CONTENT_BLOCKReturn one persisted Braze Content Block by API identifier, optionally with its current campaign and Canvas inclusion records.Input Parameters
Output
Get Content Block Translation Source
Get Content Block Translation Source
Get Custom Event Analytics
Get Custom Event Analytics
Get Email Template
Get Email Template
BRAZE_GET_EMAIL_TEMPLATEReturn one stored HTML email template by API identifier. Braze does not accept drag-and-drop-editor templates on this endpoint.Input Parameters
Output
Get Email Template Translation Source
Get Email Template Translation Source
Get Preference Center
Get Preference Center
Get Purchase Series
Get Purchase Series
Get Segment
Get Segment
Get Segment Analytics
Get Segment Analytics
Get Send Analytics
Get Send Analytics
BRAZE_GET_SEND_ANALYTICSGet 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 definitions differ.Input Parameters
Output
Get Session Analytics
Get Session Analytics
Get Subscription Group Status
Get Subscription Group Status
BRAZE_GET_SUBSCRIPTION_GROUP_STATUSGet 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.Input Parameters
Output
Get User KPI Series
Get User KPI Series
BRAZE_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. Optionally filter to one Braze app. The selected metric determines the exact Braze KPI endpoint.Input Parameters
Output
Get Webhook Template Translation Source
Get Webhook Template Translation Source
BRAZE_GET_WEBHOOK_TEMPLATE_TRANSLATION_SOURCERead 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.Input Parameters
Output
Identify Users
Identify Users
BRAZE_IDENTIFY_USERSAssign 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,000 requests/minute rate limit. A 201 success only confirms acceptance: case mismatches, duplicate matches, or prioritization can produce no merge.Input Parameters
Output
List Campaigns
List Campaigns
BRAZE_LIST_CAMPAIGNSReturn one page of Braze campaigns for discovery, optionally including archived campaigns and filtering by last edit time.Input Parameters
Output
List Campaign Translations
List Campaign Translations
List Canvases
List Canvases
BRAZE_LIST_CANVASESReturn 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.Input Parameters
Output
List Canvas Translations
List Canvas Translations
List Catalog Items
List Catalog Items
BRAZE_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. 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. Requires the immutable catalogs.get_items API-key permission and shares the 50 requests/minute synchronous catalog item limit.Input Parameters
Output
List Catalogs
List Catalogs
List Cloud Data Ingestion Integrations
List Cloud Data Ingestion Integrations
List Cloud Data Ingestion Sync Statuses
List Cloud Data Ingestion Sync Statuses
List Content Blocks
List Content Blocks
BRAZE_LIST_CONTENT_BLOCKSReturn one offset-based page of persisted Braze Content Blocks. Omit offset on the first call and use next_request only when it is returned.Input Parameters
Output
List Content Block Translations
List Content Block Translations
List Custom Attributes
List Custom Attributes
BRAZE_LIST_CUSTOM_ATTRIBUTESReturn one fixed provider page of up to 50 alphabetically sorted custom-attribute definitions and a Link-header continuation cursor. 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.Input Parameters
Output
List Custom Event Names
List Custom Event Names
BRAZE_LIST_CUSTOM_EVENT_NAMESReturn one fixed provider page of up to 250 alphabetically sorted custom event names. 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.Input Parameters
Output
List Custom Events
List Custom Events
BRAZE_LIST_CUSTOM_EVENTSReturn one fixed provider page of up to 50 alphabetically sorted custom-event definitions and a Link-header continuation cursor. 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.Input Parameters
Output
List Email Template Locale Translations
List Email Template Locale Translations
BRAZE_LIST_EMAIL_TEMPLATE_LOCALE_TRANSLATIONSView email template translations, optionally filtered to one locale. Braze documents locale_id as optional: when omitted, this action sends no locale filter and returns Braze’s translation-list response without asserting which locales Braze will include. Requires templates.translations.get, a multi-language template, and observes a 250,000 requests/minute limit.Input Parameters
Output
List Email Templates
List Email Templates
BRAZE_LIST_EMAIL_TEMPLATESReturn one offset-based page of stored HTML email templates. Drag-and-drop templates are excluded; omit offset on the first call.Input Parameters
Output
List Email Template Translations
List Email Template Translations
List Hard Bounced Emails
List Hard Bounced Emails
BRAZE_LIST_HARD_BOUNCED_EMAILSReturn hard-bounced emails as a newest-first offset page for a date range, or check an exact email. End date and either start date or email are required; email takes precedence and exact lookups must omit limit and offset; default rate limit is 250,000 requests/hour.Input Parameters
Output
List Invalid Phone Numbers
List Invalid Phone Numbers
BRAZE_LIST_INVALID_PHONE_NUMBERSReturn a newest-first offset page of invalid SMS numbers by UTC date range, or check exact E.164 numbers. Exact numbers take precedence over dates and cannot be combined with limit or offset; reasons are provider_error or deactivated, and the default rate limit is 250,000 requests/hour.Input Parameters
Output
List Preference Centers
List Preference Centers
BRAZE_LIST_PREFERENCE_CENTERSList all available Braze preference centers and their IDs and timestamps. Braze exposes no page-size control or resumable boundary, so a local 10-item cap would hide centers and save context tokens, not provider requests. Limited to 1,000 requests/minute per workspace. Braze publishes no separate plan-tier gate.Output
List Purchase Products
List Purchase Products
BRAZE_LIST_PURCHASE_PRODUCTSReturn every product ID from an optional caller-selected provider page. Braze documents page as a string but does not publish a page size, continuation token, or terminal marker, so a local 10-item cap could hide products and would save context tokens, not provider requests.Input Parameters
Output
List Scheduled Broadcasts
List Scheduled Broadcasts
BRAZE_LIST_SCHEDULED_BROADCASTSList dashboard and API scheduled campaigns and Canvas entries through an ISO 8601 end date. Recurring broadcasts appear only once at their next occurrence. Braze exposes no page-size control or resumable boundary, so a local 10-item cap would hide broadcasts and save context tokens, not provider requests. Requires messages.schedule_broadcasts and uses the default 250,000 requests/hour limit.Input Parameters
Output
List SDK Authentication Keys
List SDK Authentication Keys
BRAZE_LIST_SDK_AUTHENTICATION_KEYSHIGH IMPACT SECURITY READ: list all SDK Authentication public keys, IDs, descriptions, and primary status for one exact app. Braze exposes no page-size control or resumable boundary, so a local 10-item cap would hide security inventory and save context tokens, not provider requests. The response contains RSA public keys, never private keys. Restrict output handling because key inventory supports security administration. Default rate limit: 250,000 requests/hour.Input Parameters
Output
List Segments
List Segments
BRAZE_LIST_SEGMENTSReturn one fixed provider page of up to 100 Braze segments and their IDs for audience discovery. 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. Archived segments are excluded by Braze and cannot be requested from this endpoint.Input Parameters
Output
List Unsubscribed Emails
List Unsubscribed Emails
BRAZE_LIST_UNSUBSCRIBED_EMAILSReturn one offset page of latest unsubscribe records for a UTC date range or exact email. end_date and either start_date or email are required. This is latest state, not full history; use Currents for history. Default rate limit: 250,000 requests/hour.Input Parameters
Output
List User Subscription Groups
List User Subscription Groups
BRAZE_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. Newly created groups with no user update are omitted. limit defaults to 10 and cannot exceed 100. Default rate limit: 250,000 requests/hour.Input Parameters
Output
List Webhook Template Translations
List Webhook Template Translations
BRAZE_LIST_WEBHOOK_TEMPLATE_TRANSLATIONSView configured translations for one webhook template, optionally filtered by locale. 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.Input Parameters
Output
Merge Users
Merge Users
BRAZE_MERGE_USERSAsynchronously merge up to 50 Braze source profiles into retained target profiles. Each completed merge is irreversible: the source profile is removed after its data is transferred to the retained target. Requires users.merge and shares a 20,000 requests/minute rate limit. Target values take precedence for existing attributes; counters and selected dates are combined. A 202 success confirms acceptance only, and invalid non-E.164 stored phones can cause a silent skipped merge.Input Parameters
Output
Remove Deprecated External IDs
Remove Deprecated External IDs
Remove Hard Bounced Emails
Remove Hard Bounced Emails
BRAZE_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. Revalidate ownership and deliverability first. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Remove Invalid Phone Numbers
Remove Invalid Phone Numbers
BRAZE_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. Confirm number ownership and deliverability first. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Remove Emails From Spam List
Remove Emails From Spam List
BRAZE_REMOVE_SPAM_EMAILSHIGH 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. Confirm recipient consent first. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Rename External IDs
Rename External IDs
BRAZE_RENAME_EXTERNAL_IDSRename up to 50 primary Braze external IDs, preserving each old ID as deprecated. Requires users.external_ids.rename, is limited to 1,000 requests/minute, logs no data points, and does not affect MAU. Items process independently; inspect rename_errors and later remove deprecated IDs when migration is complete.Input Parameters
Output
Replace Catalog Item
Replace Catalog Item
BRAZE_REPLACE_CATALOG_ITEMSynchronously replace a Braze catalog item, creating it if item_id does not exist. Requires the immutable catalogs.replace_item API-key permission and shares a 50 requests/minute synchronous item limit.Input Parameters
Output
Replace Multiple Catalog Items
Replace Multiple Catalog Items
BRAZE_REPLACE_CATALOG_ITEMSAsynchronously replace or create up to 50 Braze catalog items by id. Requires the immutable catalogs.replace_items API-key permission and shares a 16,000 requests/minute asynchronous item limit. Catalog storage limits can reject the request. A 202 response is acceptance only, with no documented job or terminal result.Input Parameters
Output
Replace Media Library Asset File
Replace Media Library Asset File
BRAZE_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. The existing asset ID and hosted URL are preserved only when Braze confirms success. The replacement extension must exactly match. Replacement supports images, SVGs, documents, fonts, contact cards, and code files; video is unsupported and provider-enforced size limits apply. This action supports the implemented asset_url mode only and does not claim replacement from HTTP status alone. Rate limit: 100/hour.Input Parameters
Output
Send Campaign Trigger
Send Campaign Trigger
BRAZE_SEND_CAMPAIGN_TRIGGERHIGH IMPACT: immediately request an API-triggered campaign send. Provide up to 50 recipients, optionally intersected with a Connected Audience. Audience-only targeting requires broadcast=true; broadcast cannot include individual recipients. An accepted send cannot be retracted. Recipient attributes can update a profile or, with send_to_existing_only=false and an external ID, create a profile. Requires an active dashboard API-triggered campaign and campaigns.trigger.send. A dispatch ID means Braze accepted one batched transmission; it does not prove per-user dispatch or delivery. Per-recipient errors are returned.Input Parameters
Output
Send Canvas Trigger
Send Canvas Trigger
BRAZE_SEND_CANVAS_TRIGGERHIGH IMPACT: immediately request entry into an API-triggered Canvas. Provide up to 50 recipients, optionally intersected with a Connected Audience. Audience-only targeting requires broadcast=true; broadcast cannot include individual recipients. Accepted entry cannot be retracted. Recipient attributes can update a profile or, with send_to_existing_only=false and an external ID, create a profile. Requires canvas.trigger.send and an active Canvas. A paused or archived 201 response is rejected because no entry occurs. A dispatch ID is acceptance, never proof of message delivery; per-recipient errors are preserved.Input Parameters
Output
Send API-Only Messages
Send API-Only Messages
BRAZE_SEND_MESSAGESHIGH IMPACT: immediately request API-only messages to existing Braze users. Individual targets are limited to 50 combined external IDs and aliases; without individuals you must explicitly set broadcast=true with a segment or Connected Audience. An accepted send cannot be retracted. Requires messages.send. Channel payloads enforce documented required fields, enums, and exclusions; rendered payload size and channel eligibility are provider gates, and a dispatch ID confirms acceptance only, not recipient dispatch or delivery.Input Parameters
Output
Send Transactional Campaign
Send Transactional Campaign
BRAZE_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 retracted. Recipient attributes can update a profile or create a missing external-ID profile before sending. This is a select-package paid capability requiring an active transactional campaign, transactional.send, and hourly units. external_send_id deduplicates for 24 hours. sent and processed are not delivery; aborted and bounced are terminal failures, while delivered confirms inbox-provider acceptance.Input Parameters
Output
Set Global Email Subscription Status
Set Global Email Subscription Status
BRAZE_SET_EMAIL_SUBSCRIPTION_STATUSHIGH IMPACT: set the global email subscription state for one to 50 exact addresses, including addresses not yet attached to a profile. Global unsubscribed overrides every subscription group. Success is rejected unless Braze explicitly returns message=success. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Set Primary SDK Authentication Key
Set Primary SDK Authentication Key
BRAZE_SET_PRIMARY_SDK_AUTHENTICATION_KEYHIGH IMPACT SECURITY OPERATION: make one exact existing SDK Authentication key the primary key for one exact app. This changes which key new SDK clients should use. Success is rejected unless the returned key list marks that exact key primary. Default rate limit: 250,000 requests/hour.Input Parameters
Output
Set Subscription Group Status
Set Subscription Group Status
BRAZE_SET_SUBSCRIPTION_GROUP_STATUSHIGH IMPACT: batch subscribe or unsubscribe up to 50 users in one exact group. Email-only or phone-only calls can affect every profile sharing the identifier; external IDs may be combined with one channel identifier. Orphaned channel states persist up to 30 days. LINE group use requires approval from the Braze customer success manager. message=success confirms acceptance only, not the resulting state. In particular, SMS double opt-in can no-op when no user profile exists. Shared V1/V2 rate limit: 5,000 requests/minute.Input Parameters
Output
Set Subscription Group Statuses
Set Subscription Group Statuses
BRAZE_SET_SUBSCRIPTION_GROUP_STATUSESHIGH IMPACT: batch subscribe or unsubscribe users across multiple groups. Each group update must use exactly one of external_ids, emails, or E.164 phones; only external IDs may span email and SMS groups in one call. Orphaned channel states persist up to 30 days. LINE group use requires approval from the Braze customer success manager. message=success confirms acceptance only, not resulting states. In particular, SMS double opt-in can no-op when no user profile exists. Shared V1/V2 rate limit: 5,000 requests/minute.Input Parameters
Output
Start Live Activity
Start Live Activity
BRAZE_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. Requires Swift SDK push-to-start setup, matching ActivityAttributes and ContentState shapes, payload-size compliance, and messages.live_activity.start. HTTP 201 means Braze received a valid request; it does not prove APNs dispatch, display, or delivery.Input Parameters
Output
Create and Update Users
Create and Update Users
BRAZE_TRACK_USERSAsynchronously ingest Braze attributes, custom events, or purchases, up to 75 combined objects per portable request. Attribute objects can create or update profiles; event and purchase objects are durably recorded. Requires users.track. Each custom attribute consumes a data point; rate limits vary by contract (3,000 requests per three seconds for data-point pricing). Inspect errors because valid requests can partially process, and separate calls are not ordered. Conflicting data may process out of order; wait five minutes between requests containing conflicting data to guarantee final ordering. Callers should batch writes instead of making one-object calls when possible.Input Parameters
Output
Trigger Cloud Data Ingestion Sync
Trigger Cloud Data Ingestion Sync
BRAZE_TRIGGER_CLOUD_DATA_INGESTION_SYNCHIGH IMPACT: enqueue a sync for an existing Cloud Data Ingestion integration. This can ingest durable user or non-user data and consume data points. A 202 success only confirms acceptance, not completion; poll sync statuses. Requires CDI entitlement and is limited to 20 requests/minute.Input Parameters
Output
Update Campaign Translations
Update Campaign Translations
BRAZE_UPDATE_CAMPAIGN_TRANSLATIONSSubmit a durable update request with translation-tag string values for one campaign message locale. This does not publish, launch, send, or prove delivery; read back the translations to verify resulting stored content. A launched campaign must first have its message saved as a draft. Requires campaigns.translations.update and has a 250,000 requests/minute limit.Input Parameters
Output
Update Campaign Trigger Schedule
Update Campaign Trigger Schedule
BRAZE_UPDATE_CAMPAIGN_TRIGGER_SCHEDULEHIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered campaign. Omitted local or optimal-time flags do not carry forward. Near send time changes are best-effort, and a local-time schedule cannot be updated after its time passed in any zone. Requires campaigns.trigger.schedule.update; the change persists until updated, deleted, or sent, and acceptance does not prove every recipient was changed.Input Parameters
Output
Update Canvas Translations
Update Canvas Translations
BRAZE_UPDATE_CANVAS_TRANSLATIONSSubmit a durable update request with translation-tag string values for one Canvas step message locale. This does not publish, launch, send, or prove delivery; read back the translations to verify resulting stored content. A launched Canvas must first have its message saved as a draft. Requires canvas.translations.update and has a 250,000 requests/minute limit.Input Parameters
Output
Update Canvas Trigger Schedule
Update Canvas Trigger Schedule
BRAZE_UPDATE_CANVAS_TRIGGER_SCHEDULEHIGH IMPACT: durably replace the full schedule for a previously scheduled API-triggered Canvas. Omitted local or optimal-time flags do not carry forward, and near-send changes are best-effort. Requires canvas.trigger.schedule.update; the change persists until updated, deleted, or entered, and acceptance does not prove every intended entry was changed.Input Parameters
Output
Update Catalog Item
Update Catalog Item
BRAZE_UPDATE_CATALOG_ITEMSynchronously patch one existing Braze catalog item. Requires the immutable catalogs.update_item API-key permission and shares a 50 requests/minute synchronous item limit. The item ID belongs only in the path.Input Parameters
Output
Update Multiple Catalog Items
Update Multiple Catalog Items
BRAZE_UPDATE_CATALOG_ITEMSAsynchronously patch up to 50 existing Braze catalog items. Requires the immutable catalogs.update_items API-key permission and shares a 16,000 requests/minute asynchronous item limit. A 202 response confirms acceptance only and supplies no documented job ID, per-item result, or completion proof.Input Parameters
Output
Update Content Block
Update Content Block
BRAZE_UPDATE_CONTENT_BLOCKPersist changes to one existing Braze Content Block by API identifier. This updates stored content only; it does not send or deliver a message.Input Parameters
Output
Update Content Block Translations
Update Content Block Translations
BRAZE_UPDATE_CONTENT_BLOCK_TRANSLATIONSSubmit a durable update request with translation-tag string values for one Content Block locale. This does not publish, send, or prove delivery in a message using the block; read back the translations to verify resulting stored content. Requires content_blocks.translations.update and has a 250,000 requests/minute limit.Input Parameters
Output
Update Email Template
Update Email Template
BRAZE_UPDATE_EMAIL_TEMPLATEPersist one or more changes to an existing Braze email template by API identifier. This updates stored content only; it does not send or deliver email.Input Parameters
Output
Update Email Template Translations
Update Email Template Translations
BRAZE_UPDATE_EMAIL_TEMPLATE_TRANSLATIONSSubmit a durable update request with translation-tag string values for one email template locale. This does not send, schedule, publish, or prove email delivery; read back the translations to verify resulting stored content. Requires templates.translations.update and has a 250,000 requests/minute limit.Input Parameters
Output
Update Live Activity
Update Live Activity
BRAZE_UPDATE_LIVE_ACTIVITYUpdate an SDK-registered iOS Live Activity without ending it. Requires matching ContentState shape, payload-size compliance, and messages.live_activity.update. An optional dismissal_date updates when the activity is removed from the UI without ending it. Use END_LIVE_ACTIVITY for the irreversible terminal operation. HTTP 201 confirms receipt only, not APNs dispatch, display, dismissal, or delivery.Input Parameters
Output
Update Message Schedule
Update Message Schedule
BRAZE_UPDATE_MESSAGE_SCHEDULEHIGH IMPACT: durably update the schedule, documented channel message objects, or both for an API-only scheduled message. The replacement persists until updated, deleted, or sent. Requires messages.schedule.update; acceptance confirms neither dispatch nor delivery.Input Parameters
Output
Update Preference Center
Update Preference Center
BRAZE_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. Omitted title, state, and options are not sent. The immutable name is not accepted. Limited to 10 requests/minute per workspace.Input Parameters
Output
Update Push Credentials
Update Push Credentials
Update User Aliases
Update User Aliases
BRAZE_UPDATE_USER_ALIASESAsynchronously request renaming of up to 50 existing Braze aliases. Requires users.alias.update and shares a 20,000 requests/minute rate limit. A success response confirms acceptance only, not completion; update ordering is not guaranteed, and a nonmatching old alias may produce no change.Input Parameters
Output
Update Webhook Template Translations
Update Webhook Template Translations
BRAZE_UPDATE_WEBHOOK_TEMPLATE_TRANSLATIONSSubmit a durable update request with translation-tag string values for one webhook template locale. This does not invoke, publish, deliver, or prove delivery of a webhook; read back the translations to verify resulting stored content. Requires templates.translations.update and webhook template translations enabled by Braze; otherwise Braze may return FEATURE_NOT_ENABLED. The endpoint has a 250,000 requests/minute limit.