# Customize locale

> For the complete documentation index, see [llms.txt](https://developers.thoughtspot.com/docs/llms.txt)

Source: https://developers.thoughtspot.com/docs/set-locale

# Customize locale

The display language of the embedded ThoughtSpot UI is determined by the user’s system locale. If your browser locale matches one of the locale options supported by ThoughtSpot, the ThoughtSpot UI automatically changes to that locale. If your browser locale is not supported by ThoughtSpot, the embedded UI is displayed in US English by default. For example, if your browser locale is an unsupported Central American locale, such as Spanish (Mexico) (es-MX), ThoughtSpot launches in en-US. If your browser doesn’t allow you to change the locale, ThoughtSpot launches in the OS locale.

If your organization manages your browser settings, and your administrator or developer has already set your browser locale, ThoughtSpot automatically defaults to that locale.

You can set locale via ThoughtSpot UI, API, and Visual Embed SDK.

### Set Locale in the SDK

If you want to set your embedded app view to a specific locale for your application users, you can configure the `locale` property in the SDK.

#### Supported locale IDs

 
| Locale | Language |
| --- | --- |
| 
`da-DK`

 | 

Dansk

 |
| 

`de-DE`

 | 

Deutsch

 |
| 

`de-CH`

 | 

Deutsch (Switzerland)

 |
| 

`en-AU`

 | 

English (Australia)

 |
| 

`en-CA`

 | 

English (Canada)

 |
| 

`en-DE`

 | 

English (Germany)

 |
| 

`en-IN`

 | 

English (India)

 |
| 

`en-NZ`

 | 

English (New Zealand)

 |
| 

`en-GB`

 | 

English (United Kingdom)

 |
| 

`en-US`

 | 

English (United States)

 |
| 

`es-ES`

 | 

Español

 |
| 

`es-US`

 | 

Español (Latinoamérica)

 |
| 

`es-MX`

 | 

Español (Mexico)

 |
| 

`fr-CA`

 | 

Français (Canada)

 |
| 

`fr-FR`

 | 

Français (France)

 |
| 

`ja-JP`

 | 

日本語

 |
| 

`ko-KR`

 | 

한국어

 |
| 

`it-IT`

 | 

Italiano

 |
| 

`nb-NO`

 | 

Norsk

 |
| 

`nl-NL`

 | 

Nederland

 |
| 

`pt-BR`

 | 

Português (Brasil)

 |
| 

`pt-PT`

 | 

Português (Portugal)

 |
| 

`ru-RU`

 | 

Pусский (ограниченный выпуск)

 |
| 

`fi-FI`

 | 

Suomi

 |
| 

`sv-SE`

 | 

Svenska

 |
| 

`zh-CN`

 | 

中文(简体)

 |
| 

`zh-HANT`

 | 

中文 (繁體)

 |

This example sets the locale of the embedded Liveboard to `Español`.

```Javascript
const liveboardEmbed = new LiveboardEmbed(document.getElementById('ts-embed'), {
    frameParams: {
        width: '100%',
        height: '100%',
    },
    liveboardId: '<%=liveboardGUID%>',
    locale: 'es-ES',
});
```

The `locale` property defines the overall language of the app, and the default formats for numbers, dates, and currencies. To override the default number, date, and currency format set by the `locale` parameter, define the following attributes in the `init` code as shown in this example:

```Javascript
init({
    //...
    numberFormatLocale: 'en-US',
    dateFormatLocale: 'en-IN',
    currencyFormat: 'USD',
});
```

-   `numberFormatLocale` _String_  
    Specify your preferred locale identifier. The numbers on the embedded visualizations will be displayed as per the defined format. For example, if you specify `en-US`, large numbers on the visualizations will be displayed with the comma thousands separator and a period decimals separator as shown here:
    
    `xxx,xxx.xx`
    
-   `dateFormatLocale` _String_  
    Specify your preferred locale identifier. For example, setting `en_US` shows the date format as `MM/dd/yyyy`.
    
-   `currencyFormat` _String_  
    Specify a three-digit currency ISO code. For example, to set currency format to United States dollar, specify `USD`.
    

## Locale settings in the UI

ThoughtSpot application users can set their locale preference on the Profile settings page. To open the profile settings page, click the user icon on the top navigation bar and then edit your locale preference.

For more information, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/locale).

## Set locale via REST API

To configure locale settings for a user via REST API, ThoughtSpot administrator can use the `"use_browser_language": true` or `"preferred_locale": "en-US"` settings when creating, importing, or updating user using the following API endpoints:

-   [POST /api/rest/2.0/users/create]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fcreate-user) (user creation)
    
-   [POST /api/rest/2.0/users/{user\_identifier}/update]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fupdate-user) (User update)
    
-   [POST /api/rest/2.0/users/import]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fimport-users) (User import)
    

The `preferred_locale` parameter allows assigning a specific locale to the user, whereas the `use_browser_language` parameter determines whether the user’s language preference should be set based on their browser’s language settings. When both parameters are defined, the user’s current locale preference is overridden and the browser’s language takes precedence.

To get details of the browser language settings for a given user, administrators can use the following API endpoints:

-   `POST /api/rest/2.0/users/search`  
    
-   `POST /api/rest/2.0/users/activate`  
    
-   `GET /api/rest/2.0/auth/session/user`  
    

## Limitations

-   By default, ThoughtSpot does not automatically translate column names, object titles, description text, formulas, or metadata entered by the user. For example, if you name a visualization **Sales performance** in any variant of English and subsequently change the locale to Español, the name of the visualization remains **Sales performance**.  
    To supply custom translations for ThoughtSpot UI strings programmatically, use the [Manual Translation REST APIs]({{navprefix}}/{{manual-translation-api}}).
    
-   If you specify a currency when uploading data, that currency format does not change when the locale changes.
    
-   ThoughtSpot translates keywords, operators, and error messages. See [Keyword reference](https://docs.thoughtspot.com/cloud/latest/keywords) for all supported languages.