> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# SetMultilingualMode

# Package: localeManagement

# Namespace: SettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-management/multilingual/locale-management/locale-settings/set-multilingual-mode.md

## Permission Scopes:
Wix Multilingual: SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS

## Introduction

Sets a site's multilingual mode.

Multilingual mode allows a site to support multiple locales. This means that when multilingual mode is enabled, you can create and manage secondary locales.

To disable multilingual mode, all secondary locales must first be removed. This action removes all translated content from your site. Disabling multilingual mode will also reset the locale settings to their default values.

<blockquote class="important">
<strong>Important:</strong>

You can only call this method on sites where a Wix user has installed the [Wix Multilingual app](https://www.wix.com/app-market/wix-multilingual?searchLocation=home).

</blockquote>

---

## REST API

### Schema

```
 Method: setMultilingualMode
 Description: Sets a site's multilingual mode.  Multilingual mode allows a site to support multiple locales. This means that when multilingual mode is enabled, you can create and manage secondary locales.  To disable multilingual mode, all secondary locales must first be removed. This action removes all translated content from your site. Disabling multilingual mode will also reset the locale settings to their default values.  <blockquote class="important"> <strong>Important:</strong>  You can only call this method on sites where a Wix user has installed the [Wix Multilingual app](https://www.wix.com/app-market/wix-multilingual?searchLocation=home).  </blockquote>
 URL: https://www.wixapis.com/v2/settings/mode
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  multilingualModeEnabled
 Method parameters: 
   param name: multilingualModeEnabled | type: multilingualModeEnabled | description: Whether to enable multilingual mode for the site.  Default: `false` | required: true
 Return type: SetMultilingualModeResponse
  - name: localeSettings | type: LocaleSettings | description: Updated locale settings. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the locale settings are updated. To prevent conflicting changes, the existing revision must be passed when updating the locale settings. 
     - name: createdDate | type: string | description: Date and time the locale settings were created. 
     - name: updatedDate | type: string | description: Date and time the locale settings were last updated. 
     - name: multilingualModeEnabled | type: boolean | description: Whether multilingual mode is enabled for the site. When enabled, you can create secondary locales.  Default: `false` 
     - name: autoSwitch | type: boolean | description: Whether the live site automatically opens in a secondary locale if the site visitor's browser is set to that locale.  Default: `false`  <blockquote class="caution">  __Caution:__ Auto-switch can harm SEO by causing duplicate content issues and restricting search engine indexing of different language versions, which limits visibility in search results.  </blockquote> 
     - name: urlStructure | type: UrlStructure | description: Defines the default method for how secondary languages appear in the live site's URL. The URL structure can be overridden per locale, using the Locale API.  Default: `"SUBDIRECTORY"` 
         - enum:
         -     SUBDIRECTORY: URL structure as a subdirectory. For example, `"www.mysite.com/fr"`.
         -     SUBDOMAIN: URL structure as a subdomain. For example, `"fr.mysite.com"`.
         -     QUERY_PARAM: URL structure as a query parameter. For example, `"www.mysite.com?lang=fr"`.
     - name: primaryLocale | type: Locale | description: The site's primary locale. 
        - name: id | type: string | description: Locale GUID.  The locale GUID is made up of the language and region codes supported by Wix. For example, `"en-US"` for U.S. English. 
        - name: revision | type: string | description: Revision number, which increments by 1 each time the locale is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale object. 
        - name: createdDate | type: string | description: Date and time the locale was created. 
        - name: updatedDate | type: string | description: Date and time the locale was last updated. 
        - name: languageCode | type: string | description: Language code. For example, `"en"` for English. 
        - name: regionCode | type: string | description: Region code. For example, `"UK"` for United Kingdom. 
        - name: visibility | type: LocaleVisibility | description: Locale visibility status. 
             - enum:
             -     HIDDEN: Locale is hidden from site visitors. A site's locale should be hidden when a translation is not ready to be exposed to visitors.
             -     VISIBLE: Locale is visible to site visitors. A site can only have up to 100 visible locales.
        - name: primaryLocale | type: boolean | description: Whether the locale is the site's primary locale. 
        - name: visitorPrimaryLocale | type: boolean | description: Whether the locale is the site's visitor primary locale. 
        - name: flag | type: string | description: Flag icon as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag icon. 
        - name: regionalFormat | type: string | description: Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` to format dates like this: `MM-DD-YYYY`. 
        - name: effectiveUrlStructure | type: UrlStructure | description: Default URL structure for the locale's live site URL, based on the locale's settings, unless overridden. 
        - name: urlStructureOverride | type: UrlStructureOverride | description: Optional override for the locale's default URL structure. 
           - name: urlStructure | type: UrlStructure | description: URL structure to use instead of the default. 
        - name: machineTranslationCode | type: string | description: Language code based on Wix's supported locales, used to specify the target language when translatable content is sent for machine translation. For example, `"ES"` for Spanish or `"ZH_TW"` for Traditional Chinese.  Default: The locale's `languageCode` value. 
        - name: effectiveDisplayName | type: string | description: The locale's `displayName`, unless overridden. 
        - name: displayName | type: string | description: Default display name for the locale, inferred from the locale GUID and region code. 
        - name: overrideDisplayName | type: string | description: Optional override for the locale's display name. 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_CONTAIN_SECONDARY_LOCALES | Description: Can't disable multilingual mode while secondary locales exist on the site.


```

### Examples

### Set Multilingual Mode
```curl
curl -X POST \
  'https://www.wixapis.com/locale-settings/v2/settings/mode' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "multilingualModeEnabled": true
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.localeManagement.SettingsService.setMultilingualMode(multilingualModeEnabled)
 Description: Sets a site's multilingual mode.  Multilingual mode allows a site to support multiple locales. This means that when multilingual mode is enabled, you can create and manage secondary locales.  To disable multilingual mode, all secondary locales must first be removed. This action removes all translated content from your site. Disabling multilingual mode will also reset the locale settings to their default values.  <blockquote class="important"> <strong>Important:</strong>  You can only call this method on sites where a Wix user has installed the [Wix Multilingual app](https://www.wix.com/app-market/wix-multilingual?searchLocation=home).  </blockquote>
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  multilingualModeEnabled
 Method parameters: 
   param name: multilingualModeEnabled | type: boolean | description: Whether to enable multilingual mode for the site.  Default: `false` | required: true
 Return type: PROMISE<SetMultilingualModeResponse>
  - name: localeSettings | type: LocaleSettings | description: Updated locale settings. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the locale settings are updated. To prevent conflicting changes, the existing revision must be passed when updating the locale settings. 
     - name: _createdDate | type: Date | description: Date and time the locale settings were created. 
     - name: _updatedDate | type: Date | description: Date and time the locale settings were last updated. 
     - name: multilingualModeEnabled | type: boolean | description: Whether multilingual mode is enabled for the site. When enabled, you can create secondary locales.  Default: `false` 
     - name: autoSwitch | type: boolean | description: Whether the live site automatically opens in a secondary locale if the site visitor's browser is set to that locale.  Default: `false`  <blockquote class="caution">  __Caution:__ Auto-switch can harm SEO by causing duplicate content issues and restricting search engine indexing of different language versions, which limits visibility in search results.  </blockquote> 
     - name: urlStructure | type: UrlStructure | description: Defines the default method for how secondary languages appear in the live site's URL. The URL structure can be overridden per locale, using the Locale API.  Default: `"SUBDIRECTORY"` 
         - enum:
         -     SUBDIRECTORY: URL structure as a subdirectory. For example, `"www.mysite.com/fr"`.
         -     SUBDOMAIN: URL structure as a subdomain. For example, `"fr.mysite.com"`.
         -     QUERY_PARAM: URL structure as a query parameter. For example, `"www.mysite.com?lang=fr"`.
     - name: primaryLocale | type: Locale | description: The site's primary locale. 
        - name: _id | type: string | description: Locale GUID.  The locale GUID is made up of the language and region codes supported by Wix. For example, `"en-US"` for U.S. English. 
        - name: revision | type: string | description: Revision number, which increments by 1 each time the locale is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale object. 
        - name: _createdDate | type: Date | description: Date and time the locale was created. 
        - name: _updatedDate | type: Date | description: Date and time the locale was last updated. 
        - name: languageCode | type: string | description: Language code. For example, `"en"` for English. 
        - name: regionCode | type: string | description: Region code. For example, `"UK"` for United Kingdom. 
        - name: visibility | type: LocaleVisibility | description: Locale visibility status. 
             - enum:
             -     HIDDEN: Locale is hidden from site visitors. A site's locale should be hidden when a translation is not ready to be exposed to visitors.
             -     VISIBLE: Locale is visible to site visitors. A site can only have up to 100 visible locales.
        - name: primaryLocale | type: boolean | description: Whether the locale is the site's primary locale. 
        - name: visitorPrimaryLocale | type: boolean | description: Whether the locale is the site's visitor primary locale. 
        - name: flag | type: string | description: Flag icon as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag icon. 
        - name: regionalFormat | type: string | description: Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` to format dates like this: `MM-DD-YYYY`. 
        - name: effectiveUrlStructure | type: UrlStructure | description: Default URL structure for the locale's live site URL, based on the locale's settings, unless overridden. 
        - name: urlStructureOverride | type: UrlStructureOverride | description: Optional override for the locale's default URL structure. 
           - name: urlStructure | type: UrlStructure | description: URL structure to use instead of the default. 
        - name: machineTranslationCode | type: string | description: Language code based on Wix's supported locales, used to specify the target language when translatable content is sent for machine translation. For example, `"ES"` for Spanish or `"ZH_TW"` for Traditional Chinese.  Default: The locale's `languageCode` value. 
        - name: effectiveDisplayName | type: string | description: The locale's `displayName`, unless overridden. 
        - name: displayName | type: string | description: Default display name for the locale, inferred from the locale GUID and region code. 
        - name: overrideDisplayName | type: string | description: Optional override for the locale's display name. 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_CONTAIN_SECONDARY_LOCALES | Description: Can't disable multilingual mode while secondary locales exist on the site.


```

### Examples

### setMultilingualMode
```javascript
import { localeSettings } from '@wix/multilingual';

async function setMultilingualMode(multilingualModeEnabled) {
  const response = await localeSettings.setMultilingualMode(multilingualModeEnabled);
};
```

### setMultilingualMode (with elevated permissions)
```javascript
import { localeSettings } from '@wix/multilingual';
import { auth } from '@wix/essentials';

async function mySetMultilingualModeMethod(multilingualModeEnabled) {
  const elevatedSetMultilingualMode = auth.elevate(localeSettings.setMultilingualMode);
  const response = await elevatedSetMultilingualMode(multilingualModeEnabled);
}
```

### setMultilingualMode (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { localeSettings } from '@wix/multilingual';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { localeSettings },
  // Include the auth strategy and host as relevant
});


async function setMultilingualMode(multilingualModeEnabled) {
  const response = await myWixClient.localeSettings.setMultilingualMode(multilingualModeEnabled);
};
```

---