deleteLocale( )

Developer Preview

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

Deletes a locale by ID.

This method removes only secondary locales from a site. You can't call this method to delete a primary locale directly.

Warning:

This method permanently deletes the specified locale and all its associated data from a site.

Tip:

You can change the primary locale by calling Create New Primary Locale. This automatically deletes the original primary locale and transfers its data to the 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
localeIdstringRequired

ID of the locale to delete.

Errors

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

Did this help?