Skip to content

View default source values for a canvas’s translation tags

get

/canvas/translations/source

Use this endpoint to view all the default translation sources for a canvas’s translation tags. These are the values with the {% translation id %} source {% endtranslation %}. See Locales in messages for more information about translation features.

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 minute.

Query parameters

Parameter Required Data Type Description
workflow_id Required String The ID of the Canvas.
step_id Required String The ID of your Canvas step.
message_variation_id Required String The ID of your message variation.
locale_id Optional String The ID (UUID) of the locale.
post_launch_draft_version Optional Boolean When true returns the latest draft version instead of the latest live published version. Defaults to false returning the latest live version.

Example request

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/canvas/translations/source?workflow_id={workflow_id}&step_id={step_id}&message_variation_id={message_variation_id}&locale_id={locale_uuid}&post_launch_draft_version=true' \
--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

{
   "translations": {
       "translation_map": {
           "id_0": "Here's a Million Dollars",
           "id_1": "Hello World!"
       }
   },
   "message": "success"
}

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": "This message does not support multi-language."
		}
	]
}
New Stuff!