Skip to main content
Braze logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 119
  • Triggers: 0
  • Slug: BRAZE
  • Version: 20261101_00

Tools

Slug: 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

string
required
One valid email address or an array of 1 to 50 valid email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_CANCEL_SEGMENT_EXPORTSAsk Braze to cancel all ongoing exports for a segment. Braze documents no response confirmation schema, so a successful call is only the provider response and must not be treated as proof that cancellation completed.

Input Parameters

string
required
Braze segment API identifier whose ongoing exports should be canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional custom send identifier.
object
Connected Audience filters.
object
required
Future send schedule.
boolean
Explicitly target the full dashboard-configured audience.
array
One to 50 specific recipients.
string
required
API-triggered campaign identifier.
object
Campaign personalization shared by all recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Canvas context shared by first-step messages.
object
Connected Audience filters.
object
required
Future Canvas entry schedule.
boolean
Explicitly target the full dashboard-configured audience.
string
required
API-triggered Canvas identifier.
array
One to 50 specific recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique catalog name. Creating the catalog persists it in the connected Braze workspace until it is explicitly deleted.
array
required
Catalog field definitions in order. Field names must be unique; the first field must be named id and have type string.
string
required
Human-readable purpose of the catalog.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Fields to create. A request supports at most 50 fields and a catalog supports at most 500 total fields. Geo values later use [longitude, latitude].
string
required
Exact name of the catalog that will receive the fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Exactly one item object containing all catalog attributes but no id; the id is supplied by item_id in the path. Arbitrary workspace fields are preserved.
string
required
ID for the new catalog item.
string
required
Exact catalog name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 new items. Every item requires a unique id and may contain arbitrary attributes matching fields already defined in the catalog.
string
required
Exact name of the destination catalog.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Selection criteria to create.
string
required
Exact name of the catalog for the selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique Content Block name under 100 characters, using only letters, numbers, hyphens, and underscores.
array
Existing Braze tag names to assign; this endpoint does not create tags.
string ("active" | "draft")
Persist as active or draft. Braze defaults omitted state to active.
string
required
HTML or text content to persist; Braze requires it to be under 51,200 UTF-8 bytes.
string
Optional non-blank description under 250 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_CREATE_EMAIL_TEMPLATEPersist an HTML email template on Braze’s Templates & Media page. This creates template content only; it does not send or deliver an email.

Input Parameters

string
required
HTML-capable email body to persist, up to Braze’s documented 400 KB limit.
array
Existing Braze tag names to assign; this endpoint does not create tags.
string
required
Email subject line; Liquid is allowed when valid in Braze.
string
Optional preview preheader used by supporting email clients.
string
required
Name of the stored email template.
string
Optional plain-text alternative body.
boolean
Enable or disable CSS inlining; omit to use the workspace default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional media-library display name; omit to use the source filename.
string
Publicly accessible HTTP(S) URL Braze will download. Provide this or asset_file, never both.
object
A local file supplied to Composio for upload to the Braze media library.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional custom send identifier.
object
Connected Audience filters.
object
required
One or more scheduled channel message objects.
object
required
Future processing schedule.
boolean
Explicitly permit a segment or audience broadcast.
string
Dashboard segment identifier.
string
Optional campaign identifier for attribution.
array
Existing user aliases.
array
Existing external user IDs.
boolean
Ignore campaign frequency caps.
string ("opted_in" | "subscribed" | "all")
Minimum subscription state eligible for this send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Immutable name containing only letters, numbers, hyphens, and underscores.
string ("active" | "draft")
Initial state; Braze defaults to active when omitted.
object
Optional viewport and favicon configuration.
string
required
Complete HTML for the hosted confirmation page.
string
Page title; Braze defaults this to Preference Center when omitted.
string
required
Complete HTML for the hosted preference-center page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact Braze App API identifier.
string
required
Non-empty administrative description for the key.
boolean
Whether to make this key the primary SDK Authentication key when it is created. Omit to leave the current primary key unchanged.
string
required
Complete PEM-formatted RSA public key. Never send a private key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional non-blank caller-selected send identifier.
string
required
Campaign identifier for performance tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 unique aliases to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API-triggered campaign identifier.
string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API-triggered Canvas identifier.
string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact name of the Braze catalog to permanently delete. Confirm that it identifies the intended catalog because deletion removes all contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact name of the catalog field to delete.
string
required
Exact name of the catalog containing the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact ID of the catalog item to delete.
string
required
Exact name of the catalog containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 exact, unique item IDs to request for asynchronous deletion.
string
required
Exact name of the catalog containing the items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact name of the catalog containing the selection.
string
required
Exact name of the selection to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_DELETE_MESSAGE_SCHEDULEHIGH IMPACT: durably cancel an API-only message schedule before it is sent. This cannot undo a send already processed. Requires messages.schedule.delete. An accepted cancellation does not prove that a send already being processed was stopped.

Input Parameters

string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact Braze App API identifier.
string
required
Exact non-primary SDK Authentication key ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Braze IDs to delete.
array
External IDs to delete.
array
Aliases to delete.
array
Prioritized E.164 phone identifiers to delete.
array
Prioritized email identifiers to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name for the duplicated campaign.
array
Existing tag names; when supplied these replace source tags.
string
required
Source campaign identifier.
string
Description for the duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name for the duplicated Canvas.
string
required
Source Canvas identifier.
array
Existing tag names; when supplied these replace source tags.
string
Description for the duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze app API identifier.
string
Optional time at which the final content becomes stale.
string
required
Registered activity push-token tag to end.
object
Optional final alert shown when ending the activity.
object
required
Final ContentState matching the app-defined shape.
string
Optional time to remove the ended activity from the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("zip" | "gzip")
Archive format; gzip is available when writing to configured cloud storage.
array
required
Specific supported user fields to export; required for portable behavior on accounts created since April 2021.
string
Optional endpoint Braze POSTs to when the asynchronous export is ready; without cloud storage the callback also contains url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze segment API identifier.
string ("zip" | "gzip")
Archive format; gzip is supported when using configured cloud storage.
array
required
User fields to export; required for portable behavior and smaller files.
string
Optional endpoint Braze POSTs to after the export is ready.
array
Up to 500 specific custom attribute names. Do not include custom_attributes in fields_to_export when using this filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Phone number to match in E.164 format: a leading + followed by up to 15 digits, beginning with a nonzero country code digit. Do not include spaces or formatting punctuation, or combine this with device_id or email_address.
string
Braze-generated user identifier to match.
string
Device identifier to match. Do not combine this with email_address or phone.
array
External user IDs to match, up to 50 per request.
array
User aliases to match, up to 50 per request; every item requires both the alias name and alias label.
string
Email address to match. Do not combine this with device_id or phone.
array
required
One or more Braze profile fields to return. This is required for portable behavior across workspaces and to minimize exported data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze external user identifier for whom to generate the URL.
string
required
Braze preference-center API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CAMPAIGNReturn configuration and delivery details for one campaign identified by its Braze campaign ID.

Input Parameters

string
required
Braze campaign API identifier, obtainable from List Campaigns.
boolean
Whether to return unpublished post-launch draft changes instead of the current launched campaign version. Braze defaults this to false when omitted.
boolean
Whether each message should include has_translatable_content. Braze defaults this to false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CAMPAIGN_ANALYTICSGet up to 100 daily campaign analytics points. Dashboard and Currents aggregation definitions can differ.

Input Parameters

integer
required
Number of days or intervals to return, from 1 through 100.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.
string
required
Braze campaign API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CAMPAIGN_TRANSLATION_SOURCERead 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.

Input Parameters

string
Optional Braze locale UUID filter.
string
required
Braze campaign ID.
string
required
Message variation ID within the campaign.
boolean
True returns the latest draft; false or omitted returns the latest live version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CANVASReturn configuration and step details for one Canvas identified by its Braze Canvas ID.

Input Parameters

string
required
Braze Canvas API identifier, obtainable from List Canvases.
boolean
Whether to return unpublished post-launch draft changes instead of the current launched Canvas version. Braze defaults this to false when omitted.
boolean
Whether each Canvas message should include has_translatable_content. Braze defaults this to false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CANVAS_ANALYTICSExport Canvas daily time-series analytics with optional variant, step, and deleted-step breakdowns. Dashboard and Currents definitions can differ.

Input Parameters

string
Number of days as a string from 1 through 14; required if starting_at is omitted.
string
required
Braze Canvas API identifier.
string
required
Required timezone-aware ISO 8601 end timestamp.
string
Optional timezone-aware ISO 8601 start timestamp.
boolean
Include Canvas step statistics.
boolean
Include statistics for deleted Canvas steps.
boolean
Include Canvas variant statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CANVAS_ANALYTICS_SUMMARYExport Canvas analytics rollups with optional variant, step, and deleted-step breakdowns. Braze normalizes range timestamps to midnight in the company time zone.

Input Parameters

string
Number of days as a string from 1 through 14; required if starting_at is omitted.
string
required
Braze Canvas API identifier.
string
required
Required timezone-aware ISO 8601 end timestamp.
string
Optional timezone-aware ISO 8601 start timestamp.
boolean
Include Canvas step statistics.
boolean
Include statistics for deleted Canvas steps.
boolean
Include Canvas variant statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CANVAS_TRANSLATION_SOURCERead 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.

Input Parameters

string
required
Canvas step ID.
string
required
Braze Canvas ID.
string
Optional Braze locale UUID filter.
string
required
Message variation ID within the Canvas step.
boolean
True returns the latest draft; false or omitted returns the latest live version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CATALOG_ITEMReturn 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.

Input Parameters

string
required
Exact catalog item ID.
string
required
Exact catalog name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CONTENT_BLOCKReturn one persisted Braze Content Block by API identifier, optionally with its current campaign and Canvas inclusion records.

Input Parameters

string
required
Exact Content Block API identifier returned by List Content Blocks or Create Content Block; names and Liquid tags are not accepted.
boolean
Set true to include message-variation API identifiers for non-archived, non-deleted campaigns and Canvases that include this block.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CONTENT_BLOCK_TRANSLATION_SOURCERead 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.

Input Parameters

string
Optional Braze locale UUID filter.
string
required
Braze Content Block ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_CUSTOM_EVENT_ANALYTICSGet 1 to 100 daily or hourly occurrence counts for one custom event, optionally filtered by app and analytics-enabled segment.

Input Parameters

string ("day" | "hour")
Analytics interval: day or hour.
string
required
Exact custom event name.
string
Optional Braze App API identifier; omit to aggregate all workspace apps.
integer
required
Number of days or intervals to return, from 1 through 100.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.
string
Optional analytics-enabled Braze segment API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact email-template API identifier returned by List Email Templates or Create Email Template; template names are not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_EMAIL_TEMPLATE_TRANSLATION_SOURCERead 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.

Input Parameters

string
required
Braze email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_PREFERENCE_CENTERGet persisted HTML, state, options, identifiers, and timestamps for one Braze preference center. Limited to 1,000 requests/minute per workspace.

Input Parameters

string
required
Braze preference-center API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_PURCHASE_SERIESGet 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.

Input Parameters

string ("day" | "hour")
Analytics interval: day or hour.
string
Optional Braze App API identifier; omit to aggregate all workspace apps.
integer
required
Number of days or intervals to return, from 1 through 100.
string ("quantity" | "revenue")
required
Purchase metric to return: quantity of items purchased or revenue.
string
Optional exact product name filter.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_SEGMENTReturn Braze’s documented configuration details for one segment identified by its segment API identifier.

Input Parameters

string
required
Braze segment API identifier, obtainable from List Segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_SEGMENT_ANALYTICSGet up to 100 daily estimated segment-size points. Export and count segment users when an exact size is required.

Input Parameters

integer
required
Number of days or intervals to return, from 1 through 100.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.
string
required
Braze segment API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Number of days or intervals to return, from 1 through 100.
string
required
Tracked Send API identifier.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.
string
required
Braze API campaign identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_GET_SESSION_ANALYTICSGet 1 to 100 daily or hourly session-count points, optionally filtered by app and analytics-enabled segment.

Input Parameters

string ("day" | "hour")
Analytics interval: day or hour.
string
Optional Braze App API identifier; omit to aggregate all workspace apps.
integer
required
Number of days or intervals to return, from 1 through 100.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.
string
Optional analytics-enabled Braze segment API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
One email or 1 to 50 emails for an email group.
array
One E.164 phone or 1 to 50 phones for an SMS or WhatsApp group.
array
One external ID or 1 to 50 external IDs. Takes query precedence when combined with email or phone.
string
required
Exact subscription group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional Braze App API identifier; omit to aggregate all workspace apps.
integer
required
Number of days or intervals to return, from 1 through 100.
string ("daily_active_users" | "monthly_active_users" | "daily_new_users" | "daily_uninstalls")
required
User KPI series to return: daily active users, monthly active users, daily new users, or daily uninstalls.
string
Optional timezone-aware ISO 8601 timestamp at which the series ends.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze webhook template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Email-only profiles to identify; provide at least one identifier collection.
array
Alias-only profiles to identify; provide at least one identifier collection.
array
Phone-only profiles to identify; provide at least one identifier collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CAMPAIGNSReturn one page of Braze campaigns for discovery, optionally including archived campaigns and filtering by last edit time.

Input Parameters

integer
Zero-based page number. Start at 0; when next_request is returned, pass all of its fields unchanged to continue.
integer
Maximum campaigns to return from the current Braze page. Defaults to 10; set explicitly as high as 100. This local context cap is not sent to Braze.
integer
Local position within the current Braze page. Use only the value from next_request when continuing; this field is not sent to Braze.
string
Return campaigns edited after this ISO 8601 timestamp.
string ("asc" | "desc")
Sort by creation time: asc for oldest first or desc for newest first.
boolean
Include archived campaigns when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CAMPAIGN_TRANSLATIONSView 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.

Input Parameters

string
Optional Braze locale UUID filter.
string
required
Braze campaign ID.
string
required
Message variation ID within the campaign.
boolean
True returns the latest draft; false or omitted returns the latest live version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Zero-based page number. Start at 0; when next_request is returned, pass all of its fields unchanged to continue.
string
Return Canvases edited after this ISO 8601 timestamp.
string ("asc" | "desc")
Sort by creation time: asc for oldest first or desc for newest first.
boolean
Include archived Canvases when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CANVAS_TRANSLATIONSPreview configured locale translations for one Canvas step message variation. Requires canvas.translations.get, multi-language support on the message, and observes a 250,000 requests/minute limit.

Input Parameters

string
required
Canvas step ID.
string
required
Braze Canvas ID.
string
Optional Braze locale UUID filter.
string
required
Message variation ID within the Canvas step.
boolean
True returns the latest draft; false or omitted returns the latest live version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque continuation cursor returned by a previous call; omit for page one.
string
Exact catalog name, required for the first page. Omit when continuing with cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CATALOGSReturn all catalogs in the connected Braze workspace. Braze exposes no page-size control or resumable boundary, so a local 10-item cap would hide catalogs and save context tokens, not provider requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CLOUD_DATA_INGESTION_INTEGRATIONSReturn one 10-item page of configured Cloud Data Ingestion integrations. Requires the workspace’s Cloud Data Ingestion entitlement and has a 50 requests/minute limit.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CLOUD_DATA_INGESTION_SYNC_STATUSESReturn one 10-item page of sync statuses for a Cloud Data Ingestion integration. Requires the workspace’s CDI entitlement and has a 100 requests/minute limit.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page.
string
required
Cloud Data Ingestion integration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum blocks on this page; defaults to 10 and permits up to 1000.
integer
Positive number of matching blocks to skip. Omit for the first page; Braze’s documented troubleshooting contract requires offset to be greater than 0.
string
Return blocks edited at or after this ISO 8601 timestamp.
string
Return blocks edited at or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_CONTENT_BLOCK_TRANSLATIONSView every configured locale translation map for one Content Block, or filter by locale. Requires content_blocks.translations.get, multi-language translation tags on the block, and observes a 250,000 requests/minute limit.

Input Parameters

string
Optional Braze locale UUID filter.
string
required
Braze Content Block ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque cursor from next_cursor; omit for the first alphabetically sorted page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Zero-based page number; each page contains up to 250 alphabetically sorted event names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque cursor from next_cursor; omit for the first alphabetically sorted page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional Braze locale UUID filter.
string
required
Braze email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum templates on this page; defaults to 10 and permits up to 1000.
integer
Positive number of matching templates to skip. Omit for the first page; although the official example uses 0, the baseline read-only provider probe observed Braze reject explicit offset=0.
string
Return templates updated at or after this ISO 8601 timestamp.
string
Return templates updated at or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_LIST_EMAIL_TEMPLATE_TRANSLATIONSView all configured translations and locales for one email template. Requires templates.translations.get, a multi-language template, and observes a 250,000 requests/minute limit.

Input Parameters

string
required
Braze email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional exact email lookup; when set, Braze ignores the date range.
integer
Maximum date-list results on this page, from 1 to 500. Composio defaults to 10; Braze defaults to 100 when omitted. Do not provide this for an exact email lookup.
integer
Number of date-list records to skip; use 0 for the first page. Do not provide this for an exact email lookup.
string
required
Required UTC end date in YYYY-MM-DD format.
string
UTC start date in YYYY-MM-DD format, earlier than end_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Date-query page size, defaulting to 10; omit for exact-number lookup.
integer
Date-query offset, defaulting to zero; omit for exact-number lookup.
string ("provider_error" | "deactivated")
Optional invalidity reason filter.
string
UTC range end in YYYY-MM-DD format; required with start_date for a date query.
string
UTC range start in YYYY-MM-DD format; required with end_date for a date query.
array
Exact E.164 numbers to check; required when no complete date range is provided. When set, Braze ignores dates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional provider page value selected by the caller.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
End of the lookup range; Braze treats the date as midnight UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact Braze App API identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Zero-based page number. Start at 0; when next_request is returned, pass all of its fields unchanged to continue.
string ("asc" | "desc")
Sort by creation time: asc for oldest first or desc for newest first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional exact email lookup; use instead of date pagination.
integer
Maximum results on this page, from 1 to 500.
integer
Number of matching records to skip; use 0 for the first page.
string
required
Required UTC end date in YYYY-MM-DD format.
string
UTC start date in YYYY-MM-DD format, earlier than end_date.
string ("asc" | "desc")
Sort oldest-to-newest (asc) or newest-to-oldest (desc).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
One email or 1 to 50 emails.
integer
Maximum users on this page; defaults to 10 and Braze permits up to 100.
array
One E.164 phone or 1 to 50 phones.
integer
Number of matching users to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional locale UUID; omission returns every configured locale.
string
required
Braze webhook template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 asynchronous profile merges. Ordering is not guaranteed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_REMOVE_EXTERNAL_IDSPermanently remove up to 50 deprecated Braze external IDs. Requires users.external_ids.remove and is limited to 1,000 requests/minute. Primary IDs cannot be removed; inspect removal_errors because valid requests can partially fail.

Input Parameters

array
required
One to 50 deprecated external IDs to remove permanently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
One valid email address or an array of 1 to 50 valid email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 exact phone numbers in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
One valid email address or an array of 1 to 50 valid email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 independent external-ID rename operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Exactly one complete replacement object with no id. Arbitrary attributes matching the catalog schema are preserved.
string
required
Exact item ID to replace or create.
string
required
Exact catalog name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 complete replacement items with unique ids. Missing ids are created; attributes must match catalog fields and remain permissive for workspace schemas.
string
required
Exact name of the catalog containing the items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact existing media-library asset ID. This is not the asset name or URL; Braze preserves this ID and its hosted URL when replacement succeeds.
string
required
Publicly accessible HTTP(S) URL Braze will download as the replacement file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional custom send identifier.
object
Connected Audience filters.
boolean
Explicitly target the full dashboard-configured audience.
array
One to 50 specific recipients.
array
Email attachments, each no larger than 2 MB.
string
required
Dashboard API-triggered campaign identifier.
object
Shared personalization values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Shared Canvas context, up to 50 KB.
object
Connected Audience filters.
boolean
Explicitly target the full dashboard-configured audience.
string
required
Dashboard API-triggered Canvas identifier.
array
One to 50 specific recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional custom send identifier.
object
Connected Audience filters.
object
required
One or more API-only channel message objects.
boolean
Explicitly permit a segment or audience broadcast.
string
Dashboard segment identifier.
string
Campaign ID required for dashboard campaign metrics and Message History.
array
Existing user aliases.
array
Existing external user IDs.
boolean
Ignore campaign frequency caps.
string ("opted_in" | "subscribed" | "all")
Minimum subscription state eligible for this send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Exactly one transactional recipient.
string
required
Transactional campaign identifier.
string
Base64-compatible 24-hour deduplication and postback correlation key.
object
Personalization values for this one recipient.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
One valid email address or an array of 1 to 50 valid email addresses.
string ("subscribed" | "unsubscribed" | "opted_in")
required
Global email state: subscribed, unsubscribed, or explicitly opted_in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact Braze App API identifier.
string
required
Exact existing SDK Authentication key ID to make primary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
One email or 1 to 50 emails; updates every matching profile.
string
One E.164 phone or 1 to 50 phones; updates every matching profile.
string
One external ID or 1 to 50 external IDs.
string ("subscribed" | "unsubscribed")
required
State to apply: subscribed or unsubscribed.
string
required
Exact subscription group identifier.
boolean
For SMS subscribed updates, enter existing users into the double opt-in workflow; ignored for email groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Group updates. Each update uses exactly one identifier family with at most 50 users. Use external_ids to update email and SMS groups in one call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze app API identifier.
string
Dashboard segment identifier.
string
Time at which content becomes stale.
string
required
Reusable custom activity identifier.
object
required
Alert used to start the Live Activity.
object
required
ContentState matching the app-defined shape.
object
Connected Audience filters.
array
One to 50 external user IDs.
object
required
Static attributes matching the registered type.
string
required
SDK-registered ActivityAttributes type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Custom events to record.
array
Purchases to record.
array
User attribute updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Cloud Data Ingestion integration ID from its dashboard URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze locale UUID to update.
string
required
Braze campaign ID.
object
required
Translation-tag IDs mapped to arbitrary translated string content for this update request.
string
required
Message variation ID within the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Complete replacement schedule; omitted flags reset behavior.
string
required
API-triggered campaign identifier.
string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Canvas step ID.
string
required
Braze Canvas ID.
string
required
Braze locale UUID to update.
object
required
Translation-tag IDs mapped to arbitrary translated string content for this update request.
string
required
Message variation ID within the Canvas step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Complete replacement schedule; omitted flags reset behavior.
string
required
API-triggered Canvas identifier.
string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Exactly one object containing attributes to edit but no id. Array fields may use $add and $remove; arbitrary catalog attributes are preserved.
string
required
Exact ID of the item to edit.
string
required
Exact catalog name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 existing items with unique ids and only attributes to change. Array fields may use $add and $remove objects; arbitrary catalog attributes are preserved.
string
required
Exact name of the catalog containing the items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Replacement name under 100 characters. Braze does not allow renaming an active Content Block.
array
Complete set of existing Braze tag names to assign; tags are not created here.
string ("active" | "draft")
required
Explicit state to retain or set. Always provide the block’s intended active or draft state because Braze defaults an omitted state to active. Braze rejects changing an active block back to draft.
string
Replacement HTML or text content; Braze requires it to be under 51,200 UTF-8 bytes.
string
Replacement non-blank description under 250 characters.
string
required
Exact API identifier returned by List Content Blocks or Create Content Block; names and Liquid tags are not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze locale UUID to update.
object
required
Translation-tag IDs mapped to arbitrary translated string content for this update request.
string
required
Braze Content Block ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Replacement HTML-capable email body.
array
Complete set of existing Braze tag names to assign; tags are not created here.
string
Replacement email subject line.
string
Replacement preview preheader.
string
Replacement template name.
string
Replacement plain-text alternative body.
string
required
Exact API identifier returned by List Email Templates or Create Email Template; template names are not accepted.
boolean
Enable or disable CSS inlining; omit to leave this setting unspecified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze locale UUID to update.
string
required
Braze email template ID.
object
required
Translation-tag IDs mapped to arbitrary translated string content for this update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Braze app API identifier.
string
Time at which content becomes stale.
string
required
Registered activity push-token tag.
object
Optional update alert.
object
required
Updated ContentState matching the app-defined shape.
string
Optional time to update when the activity is removed from the UI without ending it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Replacement channel message objects.
object
Replacement schedule.
string
required
Schedule identifier returned at creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("active" | "draft")
Optional replacement active or draft state.
object
Optional replacement viewport and favicon configuration.
string
required
Complete replacement HTML for the confirmation page.
string
Optional replacement page title; omitted values are not sent.
string
required
ID of the preference center to replace.
string
required
Complete replacement HTML for the preference-center page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAZE_UPDATE_PUSH_CREDENTIALSHIGH IMPACT: replace one app’s push credentials for exactly one platform. A bad credential can stop push delivery. Braze documents no endpoint-specific rate limit or public plan gate; the workspace must expose the Apps credential API.

Input Parameters

object
APNs .p8 credentials; mutually exclusive with other platforms.
string
required
Braze app identifier API key from Settings > App Settings.
object
Huawei credentials; mutually exclusive with other platforms.
object
Amazon credentials; mutually exclusive with other platforms.
object
Firebase credentials; mutually exclusive with other platforms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
One to 50 alias rename operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
Configured Braze locale UUID to update for this webhook template.
string
required
Braze webhook template ID.
object
required
Translation-tag IDs mapped to arbitrary translated string content for this update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not