> 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

# Package: localeManagement

# Namespace: localeSettings

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/multilingual/locale-management/locale-settings/locale-settings-updated.md

## Introduction

Triggered when locale settings are updated.

---

## REST API

### Schema

```
Webhook: Locale Settings Updated
Description: Triggered when locale settings are updated.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: updatedEvent | type: object | description: Updated event details.
    - name: currentEntity | type: LocaleSettings | description: The entity after the update.
        - 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.
               - 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: 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.
                   - 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: 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.
    - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.

```

### Examples


```curl
{
  "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
  "entityFqdn": "wix.multilingual.settings.v2.locale_settings",
  "slug": "updated",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "updatedEvent": {
    "currentEntityAsJson": "{\"revision\":\"2\",\"createdDate\":\"2025-01-11T19:05:03.413Z\",\"updatedDate\":\"2025-01-11T19:05:03.413Z\",\"multilingualModeEnabled\":false,\"autoSwitch\":false,\"urlStructure\":\"SUBDIRECTORY\",\"primaryLocale\":{\"id\":\"en\",\"revision\":\"1\",\"createdDate\":\"2025-01-11T19:05:03.343Z\",\"updatedDate\":\"2025-01-11T19:05:03.343Z\",\"languageCode\":\"en\",\"regionCode\":null,\"visibility\":\"VISIBLE\",\"primaryLocale\":true,\"visitorPrimaryLocale\":true,\"flag\":\"USA\",\"regionalFormat\":\"en-US\",\"effectiveUrlStructure\":\"SUBDIRECTORY\",\"urlStructureOverride\":null,\"machineTranslationCode\":\"EN\",\"effectiveDisplayName\":\"English\",\"displayName\":\"English\",\"overrideDisplayName\":null}}"
  },
  "eventTime": "2020-10-18T13:40:58.304800Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onLocaleSettingsUpdated
Description: Triggered when locale settings are updated.
Payload: LocaleSettingsUpdatedEnvelope
  - name: entity | type: LocaleSettings | description: none
     - 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.
             - 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: 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.
                 - 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: 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.
  - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.
     - ONE-OF:
        - name: nullValue | type:  | description: 
        - name: numberValue | type: number | description: 
        - name: stringValue | type: string | description: 
        - name: boolValue | type: boolean | description: 
        - name: structValue | type: object | description: 
        - name: listValue | type: ListValue | description: 
           - name: values | type: array<Value> | description: 
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

```

### Examples


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

localeSettings.onLocaleSettingsUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { localeSettings } from '@wix/multilingual';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      localeSettings,
    },
});

wixClient.localeSettings.onLocaleSettingsUpdated((event) => {
    // handle your event here
});
```

---