View translations for a campaign

get

/campaigns/translations

Use this endpoint to view all the translations for each message variant in a campaign.

important:

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 campaigns.translations.get permission.

Rate limit

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

Query parameters

Parameter Required Data Type Description

campaign_id Required for translating a campaign String The ID of your campaign.

message_variation_id Required String The ID of your message variation.

note:

Note all translation IDs are considered universal unique identifiers (UUIDs), which can be found in Multi-Language Support settings or in the request response.

Example request

curl --location --request GET 'https://rest.iad-03.braze.com/campaigns/translations' \
--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.

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
	"translations": [
		{
			"translation_map": {
				"id_0": "¡Hola!",
				"id_1": "Me llamo Jacky",
				"id_2": "¿Dónde está la biblioteca?"
			},
			"locale": {
				"uuid": "a1b2c3d4-e5f6-g7h8-123a-a1234bn5678d",
 				"name": "es-MX",
 				"country": "Mexico",
 				"language": "Spanish",
			}
		},
		{
			"translation_map": {
				"id_0": "你好",
				"id_1": "我的名字是 Jacky",
				"id_2": "圖書館在哪裡?"
			},
			"locale": {
 				"name": "zh-HK",
 				"country": "Hong Kong",
 				"language": "Chinese (Traditional)",
			}
		}
	]
}

Example error response

The status code 400 could return the following response body. Refer to Troubleshooting for more information about errors you may encounter.

{
	"errors": [
		{
			"message": "This message does not support multi-language."
		}
	]
}

Troubleshooting

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

Error message Troubleshooting

INVALID_CAMPAIGN_ID Confirm the campaign ID matches the campaign you’re translating.

INVALID_MESSAGE_VARIATION_ID Confirm your message ID is correct.

MESSAGE_NOT_FOUND Check that the message to be translated.

MULTI_LANGUAGE_NOT_ENABLED Multi-language settings aren’t turned on for your workspace.

MULTI_LANGUAGE_NOT_ENABLED_ON_MESSAGE Only email campaigns or Canvas messages with emails can be translated.

UNSUPPORTED_CHANNEL Only messages in email campaigns or Canvas messages with emails can be translated.

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Edit this page on GitHub

New Stuff!