Locales in messages
After adding locales to your workspace, you can target users in different languages all within a single in-app message.
Prerequisites
To edit and manage multi-language support, you must have the “Manage Multi-Language Settings” user permission. To add the locale to a message, you’ll need permissions for editing campaigns.
Using locales
To use locales in your messaging, compose an in-app message campaign or Canvas. Select either the drag-and-drop editor or the traditional editor, then follow the steps based on your editor.
- Add translation tags
{% translation %}and{% endtranslation %}to wrap all text and image or link URLs to be translated. - Add an ID tag to each translation tag. An example is:
{% translation id_1 %}
- After adding the tags, save your message as a draft.
- Select Manage languages and add your locales for the message using the dropdown.
- Select Download template to download the translation template as a CSV file. Then, fill in the translations in the CSV file.
- Select Upload translations to upload the CSV file with the completed translations.
- Add translation tags
{% translation %}and{% endtranslation %}to wrap all text and image or link URLs to be translated. - Add an ID tag to each translation tag. An example is:
{% translation id_1 %}
- After adding the tags, save your message as a draft, and then open the editor again.
- In the Build panel, select Multi-language and add your locales for the message using the dropdown.
- Select Download template to download the translation template as a CSV file.
- Fill in the translations in the CSV file. If you’ve copied and pasted the translation tags directly from Step 1, you may need to remove
<code>from the Translation tags column of the CSV file. - Select Upload translations to upload the CSV file with the completed translations.
Any changes to the IDs or locales in the CSV file will not automatically update in your message. To update the translations, update the CSV file and re-upload the file.
Check out our Translation API to manage and update translations in your campaigns and Canvases.
Preview your locales
In the Preview message as user dropdown within the Test tab, select Custom user and enter different languages to preview the message to check if your message translates as expected.
Frequently asked questions
Can I make a change to the translated copy in one of my locales?
Yes. First, make the edit in the CSV, then upload the file again to make a change to the translated copy.
Can I nest translation tags?
No.
Can I add HTML styling in the translation tags?
Yes, but be sure to check that the HTML styling is not translated with the content.
What validations or extra checks does Braze do?
| Scenario | Validation in Braze |
|---|---|
| A translation file is missing locales associated with the current message. | This translation file won’t be uploaded. |
| A translation file is missing text blocks, such as a text within Liquid translation tags, from the current email message. | This translation file won’t be uploaded. |
| The translation file includes the default text that doesn’t match the text blocks in the current email message. | This translation file won’t be uploaded. Fix this in your CSV before attempting to upload again. |
| The translation file includes locales that don’t exist in Multi-Language Support settings. | These locales will not be saved in Braze. |
| The translation file includes text blocks that don’t exist in the current message (such as the current draft at the time the translations are uploaded). | The text blocks that don’t exist in your current message will not be saved from the translation file to Braze. |
| Removing a locale from the message after that locale has already been uploaded to the message as part of the translation file. | Removing the locale will remove any translations associated with the locale in your message. |
Edit this page on GitHub