> 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

# BulkCreateLocales

# Package: localeManagement

# Namespace: LocalesService

# Method link: https://dev.wix.com/docs/api-reference/business-management/multilingual/locale-management/locales/bulk-create-locales.md

## Permission Scopes:
Wix Multilingual: SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS

## Introduction

Creates multiple secondary locales.

<blockquote class="important">
<strong>Important:</strong>

- This method can only be called on sites where multilingual mode is enabled.

</blockquote>

---

## REST API

### Schema

```
 Method: bulkCreateLocales
 Description: Creates multiple secondary locales.  <blockquote class="important"> <strong>Important:</strong>  - This method can only be called on sites where multilingual mode is enabled.  </blockquote>
 URL: https://www.wixapis.com/v2/bulk/locale/create
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  locales, locales.languageCode
 Method parameters: 
   param name: locales | type: array<locales> | description: Locales to create. | required: true
              - name: languageCode | type: string | description: Language code. For example, `"en"` for English. | required: true
              - 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: 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: 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: overrideDisplayName | type: string | description: Optional override for the locale's display name. 
   param name: returnEntity | type: returnEntity | description: Whether to receive the created locales in the response. 
 Return type: BulkCreateLocalesResponse
  - name: results | type: array<BulkLocaleResult> | description: Information about the created locales. 
     - name: itemMetadata | type: ItemMetadata | description: Item metadata. 
        - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - 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: item | type: Locale | description: Created locale. Returned when `returnEntity` is set to `true`. 
        - 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: bulkActionMetadata | type: BulkActionMetadata | description: Bulk metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 


```

### Examples

### Bulk Create Locales
```curl
curl -X POST \
  'https://www.wixapis.com/locales/v2/bulk/locale/create' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "locales": [
      {
        "languageCode": "en",
        "visibility": "VISIBLE",
        "flag": "USA"
      }
    ],
    "returnEntity": true
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.localeManagement.LocalesService.bulkCreateLocales(locales, options)
 Description: Creates multiple secondary locales.  <blockquote class="important"> <strong>Important:</strong>  - This method can only be called on sites where multilingual mode is enabled.  </blockquote>
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  locales, locales.languageCode
 Method parameters: 
   param name: locales | type: array<array> | description: Locales to create. | required: true
              - name: languageCode | type: string | description: Language code. For example, `"en"` for English. | required: true
              - 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: 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: 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: overrideDisplayName | type: string | description: Optional override for the locale's display name. 
   param name: options | type: BulkCreateLocalesOptions  none 
        - name: returnEntity | type: boolean | description: Whether to receive the created locales in the response. 
 Return type: PROMISE<BulkCreateLocalesResponse>
  - name: results | type: array<BulkLocaleResult> | description: Information about the created locales. 
     - name: itemMetadata | type: ItemMetadata | description: Item metadata. 
        - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - 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: item | type: Locale | description: Created locale. Returned when `returnEntity` is set to `true`. 
        - 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: bulkActionMetadata | type: BulkActionMetadata | description: Bulk metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 


```

### Examples

### bulkCreateLocales
```javascript
import { locales } from '@wix/multilingual';

async function bulkCreateLocales(locales,options) {
  const response = await locales.bulkCreateLocales(locales,options);
};
```

### bulkCreateLocales (with elevated permissions)
```javascript
import { locales } from '@wix/multilingual';
import { auth } from '@wix/essentials';

async function myBulkCreateLocalesMethod(locales,options) {
  const elevatedBulkCreateLocales = auth.elevate(locales.bulkCreateLocales);
  const response = await elevatedBulkCreateLocales(locales,options);
}
```

### bulkCreateLocales (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 bulkCreateLocales(locales,options) {
  const response = await myWixClient.locales.bulkCreateLocales(locales,options);
};
```

---