Leftover deploy - May 2, 2024

_docs/_api/endpoints/translations.md

@@ -0,0 +1,38 @@
+---
+nav_title: Translations
+article_title: Translation Endpoints
+search_tag: Endpoint
+page_order: 9
+layout: dev_guide
+
+description: "This landing page lists the Braze translation endpoints."
+page_type: landing
+
+guide_top_header: "Translation Endpoints"
+guide_top_text: "Use the Braze translation endpoints to manage and update translations in your campaigns and Canvases."
+
+guide_featured_title: ""
+guide_featured_list:
+  - name: "GET: Translate Multiple Campaigns"
+    link: /docs/api/endpoints/translations/get_bulk_translations_campaigns/
+    fa_icon: fas fa-list-ul
+  - name: "GET: Translate Multiple Canvases"
+    link: /docs/api/endpoints/translations/get_bulk_translations_canvases/
+    fa_icon: fas fa-list-ul
+  - name: "GET: Translate A Campaign"
+    link: /docs/api/endpoints/translations/get_translation_campaign/
+    fa_icon: fas fa-list-ul
+  - name: "GET: Translate A Canvas"
+    link: /docs/api/endpoints/translations/get_translation_canvas/
+    fa_icon: fas fa-list-ul
+  - name: "PUT: Update Translation in a Campaign"
+    link: /docs/api/endpoints/translations/update_translation_campaign/
+    fa_icon: fas fa-user
+  - name: "PUT: Update Translation in a Canvas"
+    link: /docs/api/endpoints/translations/update_translations_canvas/
+    fa_icon: fas fa-user
+---
+
+{% alert important %}
+The Braze translation endpoints are currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
+{% endalert %}

_docs/_api/endpoints/translations/get_bulk_translations_campaigns.md

@@ -0,0 +1,104 @@
+---
+nav_title: "GET: View Translations for a Campaign"
+article_title: "GET: View Translations for a Campaign"
+search_tag: Endpoint
+page_order: 1
+
+layout: api_page
+page_type: reference
+description: "This article outlines details about the View translations for a campaign endpoint."
+---
+
+{% api %}
+# View translations for a campaign
+{% apimethod get %}
+/campaigns/translations
+{% endapimethod %}
+
+> Use this endpoint to view all the translations for each message variant in a campaign.
+
+{% alert important %}
+Viewing translations for campaign messages via API is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
+{% endalert %}
+
+## Prerequisites
+
+To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `campaigns.translations.get` permission.
+
+## Rate limit
+
+This endpoint has a rate limit of 250,000 requests per hour.
+
+## Path parameters
+
+| Parameter | Required | Data Type | Description |
+| --------- | ---------| --------- | ----------- |
+|`campaign_id`| Required for translating a campaign | String | The ID of your campaign. |
+{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4}
+
+## Example request
+
+```
+curl --location --request GET 'https://rest.iad-03.braze.com/campaign/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.
+
+```json
+Content-Type: application/json
+Authorization: Bearer YOUR-REST-API-KEY
+{
+	"translations": [
+		{
+			"locale": {
+ 				"name": "zh-HK",
+ 				"country": "Hong Kong",
+ 				"language": "Chinese (Traditional)",
+			},
+			"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](#troubleshooting) for more information about errors you may encounter.
+
+```json
+{
+	"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. |
+{: .reset-td-br-1 .reset-td-br-2}
+
+{% endapi %}

_docs/_api/endpoints/translations/get_bulk_translations_canvases.md

@@ -0,0 +1,105 @@
+---
+nav_title: "GET: View Translations for a Canvas"
+article_title: "GET: View Translations for a Canvas"
+search_tag: Endpoint
+page_order: 1
+
+layout: api_page
+page_type: reference
+description: "This article outlines details about the List translations for a Canvas endpoint."
+---
+
+{% api %}
+# List translations for a Canvas
+{% apimethod get %}
+/canvases/translations
+{% endapimethod %}
+
+> Use this endpoint to view all the translations for a Canvas.
+
+{% alert important %}
+Viewing translations for a Canvas via API is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
+{% endalert %}
+
+## Prerequisites
+
+To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `canvas.translations.get` permission.
+
+## Rate limit
+
+This endpoint has a rate limit of 250,000 requests per hour.
+
+## Path parameters
+
+| Parameter | Required | Data Type | Description |
+| --------- | ---------| --------- | ----------- |
+|`canvas_id`| Required | String | The ID of your Canvas. |
+|`step_id`| Required | String | The ID of your Canvas step. |
+{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4}
+
+## Example request
+
+```
+curl --location --request GET 'https://rest.iad-03.braze.com/canvas/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.
+
+```json
+Content-Type: application/json
+Authorization: Bearer YOUR-REST-API-KEY
+{
+	"translations": [
+		{
+			"locale": {
+ 				"name": "zh-HK",
+ 				"country": "Hong Kong",
+ 				"language": "Chinese (Traditional)",
+			},
+			"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](#troubleshooting) for more information about errors you may encounter.
+
+```json
+{
+	"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. |
+{: .reset-td-br-1 .reset-td-br-2}
+
+{% endapi %}

_docs/_api/endpoints/translations/get_translation_campaign.md

@@ -0,0 +1,109 @@
+---
+nav_title: "GET: View Translation for a Campaign"
+article_title: "GET: View Translation for a Campaign"
+search_tag: Endpoint
+page_order: 1
+
+layout: api_page
+page_type: reference
+description: "This article outlines details about the View Translation for a campaign endpoint."
+---
+
+{% api %}
+# View translation for a campaign
+{% apimethod get %}
+/campaign/translations/?locale_id={locale_id}
+{% endapimethod %}
+
+> Use this endpoint to view a translated campaign message to see what this message looks like for a user.
+
+{% alert important %}
+Viewing a translated campaign message via API is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
+{% endalert %}
+
+## Prerequisites
+
+To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `campaigns.translations.get` permission.
+
+## Rate limit
+
+This endpoint has a rate limit of 250,000 requests per hour.
+
+## Path parameters
+
+| Parameter | Required | Data Type | Description |
+| --------- | ---------| --------- | ----------- |
+|`campaign_id`| Required | String | The ID of your campaign. |
+|`message_variation_id`| Required | String | The ID for your message variation. |
+|`locale_id`| Required | String | The ID of the locale. |
+{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4}
+
+
+## Example request
+
+```
+curl --location --request GET 'https://rest.iad-03.braze.com/campaign/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.
+
+```json
+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](#troubleshooting) for more information about errors you may encounter.
+
+```json
+{
+	"errors": [
+		{
+			"message": "Invalid locale ID"
+		}
+	]
+}
+```
+
+## 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_LOCALE_ID`                     | Confirm your locale ID exists in your message translation.                         |
+| `INVALID_MESSAGE_VARIATION_ID`          | Confirm your message ID is correct.                                                |
+| `MESSAGE_NOT_FOUND`                     | Check that the message to be translated.                                           |
+| `LOCALE_NOT_FOUND`                      | Confirm the locale exists in your multi-language settings.                         |
+| `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. |
+{: .reset-td-br-1 .reset-td-br-2}
+
+{% endapi %}