createNewPrimaryLocale( )

Creates and assigns a new primary locale for a site.

This method changes the site's primary locale. The process may take time, depending on the amount of content present on the site. When called, this method returns a token, which you can use with the Get New Primary Locale Status method to check the status of the primary locale change.

Important:
  • The desired new primary locale can't already exist as a secondary locale on the site. If the locale is already a secondary locale on the site, you must first remove it from the site by calling Delete Locale before changing the primary locale.
  • This method automatically deletes the original primary locale and transfers its data to the new primary locale.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Wix Multilingual
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
primaryLocaleV2LocaleRequired

New primary locale.

Returns
Return Type:Promise<CreateNewPrimaryLocaleResponse>
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?