---
title: "PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate"
method: PUT
path: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate"
---

# PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate

`PUT /bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/batchupdate`

Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.

## Path parameters

- `botId` string, required
- `botVersion` string, required
- `localeId` string, required

## Request body

- object
  - `customVocabularyItemList` CustomVocabularyItem[], required — A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
    - `itemId` string, required — The unique item identifer for the custom vocabulary item from the custom vocabulary list.
    - `phrase` string, required — The unique phrase for the custom vocabulary item from the custom vocabulary list.
    - `weight` integer — The weight assigned for the custom vocabulary item from the custom vocabulary list.
    - `displayAs` string — The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

## Response `200`

Success

- BatchUpdateCustomVocabularyItemResponse
  - `botId` string — The identifier of the bot associated with this custom vocabulary.
  - `botVersion` string — The identifier of the version of the bot associated with this custom vocabulary.
  - `localeId` string — The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.
  - `errors` FailedCustomVocabularyItem[] — A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.
    - `itemId` string — The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
    - `errorMessage` string — The error message for the failed custom vocabulary item from the custom vocabulary list.
    - `errorCode` 'DUPLICATE_INPUT' | 'RESOURCE_DOES_NOT_EXIST' | 'RESOURCE_ALREADY_EXISTS' | 'INTERNAL_SERVER_FAILURE' — The unique error code for the failed custom vocabulary item from the custom vocabulary list.
  - `resources` CustomVocabularyItem[] — A list of custom vocabulary items that were successfully updated during the operation.
    - `itemId` string, required — The unique item identifer for the custom vocabulary item from the custom vocabulary list.
    - `phrase` string, required — The unique phrase for the custom vocabulary item from the custom vocabulary list.
    - `weight` integer — The weight assigned for the custom vocabulary item from the custom vocabulary list.
    - `displayAs` string — The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

## Other responses

- `480` — ThrottlingException
- `481` — ServiceQuotaExceededException
- `482` — ValidationException
- `483` — ResourceNotFoundException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/models-lex-v2.md) · [All operations](https://skmtc.net/aws/apis/models-lex-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/models-lex-v2/versions/4ee1a1257ae7/schema)