createLocale( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new secondary locale.

This method adds a new secondary locale to the site. A site can have up to 200 locales and up to 100 visible locales.

To retrieve a list of all locales supported by Wix that can be created on a site, call List Supported Locales.

Important:
  • This method can only be called on sites where multilingual mode is enabled.
  • This method creates only secondary locales. To create and set a new primary locale, call Create New Primary Locale.
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Wix Multilingual
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
localeV2LocaleRequired

Locale to create.

Returns
Return Type:Promise<V2Locale>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?