Translation Language
Use the Translation Language screen to view and update the preferred spoken language used for translation services.
The selected language applies to translation-related features available to the user.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Language selection section | Displays available spoken languages |
| 2 | Language option | Selects a preferred spoken language |
| 3 | Selected language state | Indicates the current language selection |
| 4 | Save Changes action | Saves the selected language |
| 5 | Close action | Closes the screen without saving changes |
Workflow
- Open the Translation Language screen.
- Load available language options.
- Select a spoken language.
- Review the selected language.
- Select Save Changes.
- Apply the updated translation language preference.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Translation Language screen opens | Display available spoken languages | PUT /api/v3/account/translation-language |
| Language selected | Update selection state | spokenLanguage = selected |
| Language available | Enable Save Changes action | state = ready |
| Request fails | Display error state | status = 405 |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Translation Language screen opened | Load available language options | PUT /api/v3/account/translation-language |
| Language selected | Update the active selection | spokenLanguage = selected |
| Save Changes selected | Save the selected language | POST /api/v3/account/translation-language |
| Language updated | Apply the updated preference | status = 204 |
| Close selected | Close the screen without updating the preference | navigation = dismiss |
Endpoint Resources
Select Translation Language
PUT
v3/account/translation-language
Returns the translation language selection screen.
The response body includes:
- Available spoken language options.
- Current language selection.
- Save Changes action.
UI Element Types
| Level | Reference | Type | Value | Placement |
|---|---|---|---|---|
| 1 | spoken-language~af | Radio | Afrikaans | |
| 1 | spoken-language~am | Radio | Amharic | |
| 1 | spoken-language~yue | Radio | Chinese – Cantonese | |
| 1 | save-changes | Button | Save changes |
Update Translation Language
POST
v3/account/translation-language
Updates the preferred spoken language used for translation services.
A successful request returns 204 No Content.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
spoken-language | String | Yes | Spoken language code used for translation services. |
Errors
| Code | Description |
|---|---|
WRONG_DATA | The selected language is invalid or unsupported. |