> 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 # GetNewPrimaryLocaleStatus # Package: localeManagement # Namespace: LocalesService # Method link: https://dev.wix.com/docs/api-reference/business-management/multilingual/locale-management/locales/get-new-primary-locale-status.md ## Permission Scopes: Wix Multilingual: SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS ## Introduction Retrieves the status of the Create New Primary Locale method. Call this method to see if your primary locale was successfully changed. Specify the token returned by Create New Primary Locale. If the token specified is invalid, a 404 error is returned. --- ## REST API ### Schema ``` Method: getNewPrimaryLocaleStatus Description: Retrieves the status of the Create New Primary Locale method. Call this method to see if your primary locale was successfully changed. Specify the token returned by Create New Primary Locale. If the token specified is invalid, a 404 error is returned. URL: https://www.wixapis.com/v2/locale/change-primary Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: token Method parameters: query param name: token | type: token | description: Token to retrieve the process status. Returned in the response of Create New Primary Locale. | required: true Return type: GetNewPrimaryLocaleStatusResponse - ONE-OF: - name: finishSuccessfulData | type: FinishSuccessfulData | description: New primary locale data when the process successfully completes. - name: newPrimaryLocale | type: Locale | description: The new 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. - 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: finishWithErrorData | type: FinishWithErrorData | description: Error details when the process fails. - name: error | type: ApplicationError | description: Error details. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: status | type: Status | description: The current status of the Create New Primary Locale method. - enum: - IN_PROGRESS: Indicates the process of creating a new primary locale is in progress. - FINISH_SUCCESSFUL: Indicates the process of creating a new primary locale was successful and all content under the previous primary locale is now tagged under the new locale. New primary locale data is available in the `finishSuccessfulData` object. - FINISH_WITH_ERROR: Indicates the process of creating a new primary locale failed. Additional error details are available in the `finishWithErrorData` object. ``` ### Examples ### Get New Primary Locale Status ```curl curl -X GET \ 'https://www.wixapis.com/locales/v2/locale/change-primary/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.localeManagement.LocalesService.getNewPrimaryLocaleStatus(token) Description: Retrieves the status of the Create New Primary Locale method. Call this method to see if your primary locale was successfully changed. Specify the token returned by Create New Primary Locale. If the token specified is invalid, a 404 error is returned. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: token Method parameters: param name: token | type: string | description: Token to retrieve the process status. Returned in the response of Create New Primary Locale. | required: true Return type: PROMISE - ONE-OF: - name: finishSuccessfulData | type: FinishSuccessfulData | description: New primary locale data when the process successfully completes. - name: newPrimaryLocale | type: Locale | description: The new 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. - 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: finishWithErrorData | type: FinishWithErrorData | description: Error details when the process fails. - name: error | type: ApplicationError | description: Error details. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: status | type: Status | description: The current status of the Create New Primary Locale method. - enum: - IN_PROGRESS: Indicates the process of creating a new primary locale is in progress. - FINISH_SUCCESSFUL: Indicates the process of creating a new primary locale was successful and all content under the previous primary locale is now tagged under the new locale. New primary locale data is available in the `finishSuccessfulData` object. - FINISH_WITH_ERROR: Indicates the process of creating a new primary locale failed. Additional error details are available in the `finishWithErrorData` object. ``` ### Examples ### getNewPrimaryLocaleStatus ```javascript import { locales } from '@wix/multilingual'; async function getNewPrimaryLocaleStatus(token) { const response = await locales.getNewPrimaryLocaleStatus(token); }; ``` ### getNewPrimaryLocaleStatus (with elevated permissions) ```javascript import { locales } from '@wix/multilingual'; import { auth } from '@wix/essentials'; async function myGetNewPrimaryLocaleStatusMethod(token) { const elevatedGetNewPrimaryLocaleStatus = auth.elevate(locales.getNewPrimaryLocaleStatus); const response = await elevatedGetNewPrimaryLocaleStatus(token); } ``` ### getNewPrimaryLocaleStatus (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 { locales } from '@wix/multilingual'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { locales }, // Include the auth strategy and host as relevant }); async function getNewPrimaryLocaleStatus(token) { const response = await myWixClient.locales.getNewPrimaryLocaleStatus(token); }; ``` ---