View a specific translation and locale for email template endpoint
/templates/translations/email
Use this endpoint to view a specific translation and locale for an email template.
This endpoint is currently in early access. Contact your Braze account manager if you’re interested in participating in the early access.
Prerequisites
To use this endpoint, you’ll need an API key with the templates.translations.get permission.
Rate limit
This endpoint has a rate limit of 250,000 requests per minute.
Query parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
template_id |
Required | String | The ID for your email template. |
locale_id |
Optional | String | The ID (UUID) of the locale. |
All translation IDs are considered universal unique identifiers (UUIDs), which can be found in the GET endpoint’s response.
Example request
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/templates/translations/email?locale_id={locale_uuid}&template_id={template_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Response
There are four status code responses for this endpoint: 200, 400, 404, and 429.
Example success response
The status code 200 could return the following response header and body.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"translations": [
{
"locale": {
"uuid": "c7c12345-te35-1234-5678-abcdefa99r3f",
"name": "es-MX",
"country": "MX",
"language": "es",
"locale_key": "es-mx"
},
"translation_map": {
"id_0": "¡Hola!",
"id_1": "Me llamo Jacky",
"id_2": "¿Dónde está la biblioteca?"
}
}
]
}
Example error response
The status code 400 could return the following response body. Refer to Troubleshooting for more information about errors you may encounter.
1
2
3
4
5
6
7
{
"errors": [
{
"message": "The provided locale code does not exist."
}
]
}
Edit this page on GitHub