-
Team, Professional, Business and Enterprise plans
Get in touch with Sales for licensing questions.
-
Ultimate and Enterprise plans (Legacy)
Get in touch with Sales for licensing questions.
The Braze Connector allows marketers to localize Braze campaigns, canvases, and templates without manual work. By connecting Phrase TMS to Braze’s Multilanguage API, multilingual content is automatically exchanged between both platforms for translation.
This integration is designed for marketers, not developers. It removes the need for code edits, file exports, or template duplication.
The connector includes a unified language mapping functionality that automatically aligns Phrase TMS language codes with Braze language codes.Common variations such as case differences (de-DE vs de-de) and separator formats (en-US vs en_us) are resolved automatically, reducing manual setup. Administrators can define custom mappings in the connector settings for non-standard or unique locale codes, which will take priority over the automatic mapping.
Automatic alerts can be configured so translators are notified when a new job arrives and marketers receive a notification when that job is completed.
Braze requires that each translation has a unique tag ID.
Note
Due to continuous improvements, the user interface may not be exactly the same as presented in the video.
Braze Content Structure
-
Templates:
Reusable message layouts—emails, in-app messages, or push notifications—that serve as the foundation of your campaigns and canvases.
-
Campaigns:
Used to send targeted messages to audiences through one or more channels (email, push, or in-app). Campaigns can be one-time, recurring, or triggered, supporting personalized, multi-channel communication.
-
Canvases:
Multi-step customer journeys that send messages across multiple channels using triggers, audience segments, and timing logic. Canvases are ideal for orchestrating behavior-based, automated engagement flows.
Localization Use Cases
-
Template-Level Localization
Localize templates before linking them to campaigns or canvases.
Limitations:
-
Supports only HTML templates for email, push, and in-app (not drag-and-drop).
-
Drag-and-drop templates are supported through Campaigns and Canvases.
-
-
Campaign and Canvas-Level Localization
When working in Campaigns or Canvases, additional message types can be localized including drag-and-drop templates.
Campaigns and Canvases serve as the delivery layer. While drag-and-drop templates can't be localized directly from the Template Library, they can be localized them when they’re used within Campaigns or Canvases. This means all message types can be translated on the appropriate layer.
Limitations
|
Limitation |
Description |
Workaround |
|---|---|---|
|
Drag-and-drop templates |
Not visible as a template |
Localize via Campaigns or Canvases, and they will be visible in Phrase TMS |
|
Locale mismatches |
Can cause job creation errors |
Keep locale codes consistent with underscores |
|
Missing permissions |
May block synchronization |
Ensure creating new API keys, with access provided for Template, Canvas, and Campaign |
|
Content Blocks |
No need to localize on a content block level |
Content blocks are resolved when templates, campaigns, or canvases are sent to localization, meaning the content of content blocks will be visible within the translated versions. |
There are a number of use cases for the connector:
-
Project managers can add files directly to projects from an online repository.
-
Set up the submitter portal to allow Submitters to add files to requests directly from the online repository.
-
Use automated project creation (APC) to have new projects automatically created when a change in the content is detected for monitored documents or a folder.
-
Only new or updated translatable content triggers APC; exporting translations or changes to non-translatable content do not create new projects.
-
-
The connector API can be used to automate steps otherwise performed manually through the UI. Webhooks can be used to have 3rd party systems notified about certain events (for example, a job status change).
-
Log in to your Braze account.
-
Navigate to under in the Developer Console.
-
Select .
If restriction is required:
-
Create a new Rest API Key.
This key is required for the connector configuration.
Ensure these permissions are selected:
-
Templates
-
Canvases
-
Campaigns
If a key had been generated for the legacy connector, this will no longer work.
-
-
Copy the Braze REST Endpoint URL.
-
Ensure languages locales under Workspace Settings - Multi-Language Locale Setttings are in the standard format with an underscore. Hyphens or other formats will cause errors.
-
For all templates requiring translation, ensure multi-language is specified with all required locales.
-
From the Settings
page, scroll down to the section.
-
Click on Connectors.
The page opens.
-
Click New connector.
The page opens.
-
Change the Type to and provide a name for the connector.
-
Select the Braze REST Endpoint URL from the dropdown list.
-
Provide the Rest API key found under .
-
Click Test connection.
-
If successful, a small checkmark appears next to the button.
-
-
If content is tagged for translation, click Show optional settings and provide tag IDs.
-
If specified, select a default folder (only possible after saving).
-
Click Save.
The connector is added to the list on the page.
When using Braze’s HTML editor, content can be localized directly at the template level. This is perfect for reusable emails.
To localize an HTML email template, follow these steps:
-
From - - , open the template.
-
Add translation tags:
-
Wrap the translateable are in Phrase tags:
{% translation phrase_body %} ...your email content here... {% endtranslation %}Tip
Place the opening tag on the first line and the closing tag on the last line of the HTML editor. Sentences do not need to be wrapped individually; the Phrase converter automatically parses everything between the two tags preparing it for translation in the Phrase TMS workspace. The HTML formatting, links, and styling remain fully intact in the localized version.
-
To translate Subject and Preheader, wrap them individually:
{% translation phrase_subject %}Subject text{% endtranslation %} {% translation phrase_preheader %}Preheader text{% endtranslation %}
-
-
Save the template.
-
Reopen the template and select and choose the source and target locales. Ensure the locales are the same as the Phrase configuration.
-
Save the template.
-
From Phrase TMS, select - - .
The HTML template appears as a translation job.
-
Translate and review.
-
Once approved, export the translations back to Braze.
Localized versions appear automatically under their assigned locales. Use - to verify the display and layout.
When localizing within campaigns or canvases, the workflow differs slightly. Instead of localizing a standalone HTML template, live or draft campaign assets that may include drag-and-drop content are worked on.
-
Localizations are not from the template library but directly within campaigns or canvases.
-
Drag-and-drop templates become localizable once used in these contexts.
-
All message types (email, push, in-app) can be localized if wrapped with Phrase tags.
To work with a campaign or canvas, follow these steps:
-
From , open required asset.
-
Add translation tags:
-
If using the HTML editor
-
Wrap the translateable are in Phrase tags:
{% translation phrase_body %} ...your email content here... {% endtranslation %}Tip
Place the opening tag on the first line and the closing tag on the last line of the HTML editor. Sentences do not need to be wrapped individually; the Phrase converter automatically parses everything between the two tags preparing it for translation in the Phrase TMS workspace. The HTML formatting, links, and styling remain fully intact in the localized version.
-
To translate Subject and Preheader, wrap them individually:
{% translation phrase_subject %}Subject text{% endtranslation %} {% translation phrase_preheader %}Preheader text{% endtranslation %}
-
For drag-and-drop emails, add one block at the top and one at the bottom of the email. Place the opening tag
{% translation phrase_body %}in the top block and the closing tag{% endtranslation %}in the bottom block. This covers the entire email; each sentence does not need to be wrapped individually.
-
-
-
Mark for translation
If the tag usage is configured at the connector level, mark the campaign or canvas with the translation tag.
-
Import to Phrase TMS
In Phrase TMS, go to - - Tagged campaigns appear for selection.
-
Translate and Review
Linguists translate within Phrase’s workspace. HTML and formatting are preserved automatically.
-
Export and Preview
Once done, export the localized version back to Braze. Use - to toggle locales and confirm.
-
Team, Professional, Business and Enterprise plans
Get in touch with Sales for licensing questions.
-
Ultimate and Enterprise plans (Legacy)
Get in touch with Sales for licensing questions.
With the Phrase TMS integration for Braze, customer engagement can be increased and growth driven into new markets with seamless localization. The integration enables Braze users to translate email templates and content blocks.
Translatable content elements:
-
Email templates created with HTML editor
-
Content blocks
Note
Due to continuous improvements, the user interface may not be exactly the same as presented in the video.
There are a number of use cases for the connector:
-
Project managers can add files directly to projects from an online repository.
-
Set up the submitter portal to allow Submitters to add files to requests directly from the online repository.
-
Use automated project creation (APC) to have new projects automatically created when a change in the content is detected for monitored documents or a folder.
-
Only new or updated translatable content triggers APC; exporting translations or changes to non-translatable content do not create new projects.
-
-
The connector API can be used to automate steps otherwise performed manually through the UI. Webhooks can be used to have 3rd party systems notified about certain events (for example, a job status change).
-
From the Settings
page, scroll down to the section.
-
Click on Connectors.
The page opens.
-
Click New connector.
The page opens.
-
Change the Type to and provide a name for the connector.
-
Select the Braze REST Endpoint URL from the dropdown list.
-
Provide the Rest API key found under .
-
Click Test connection.
-
If successful, a small checkmark appears next to the button.
-
-
If content is tagged for translation, click Show optional settings and provide tag IDs.
-
If specified, select a default folder (only possible after saving).
-
Click Save.
The connector is added to the list on the page.