View translation for a Canvas

Use this endpoint to view a translated message to see what this message looks like for a user.

Prerequisites

To use this endpoint, you’ll need an API key with the canvas.translations.get permission.

Rate limit

This endpoint has a rate limit of 250,000 requests per hour.

Path parameters

Example request

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/?locale_id={locale_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
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
	"translations": [
		{
			"locale": {
 				"name": "es-MX",
 				"country": "Mexico",
 				"language": "Spanish",
			},
			"translation_map": {
				"id_0": "Hello",
				"id_1": "My name is Jacky",
				"id_2": "Where is the library?"
			}
		}
	]
}

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": "Invalid locale ID"
		}
	]
}

Troubleshooting

The following table lists possible returned errors and their associated troubleshooting steps.