Get botsbotidbotversionsbotversionbotlocaleslocaleidcustomvocabularydefaultmetadata

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Provides metadata information about a custom vocabulary.

get/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/metadata

botIdstring required

The unique identifier of the bot that contains the custom vocabulary.

botVersionstring required

The bot version of the bot to return metadata for.

localeIdstring required

The locale to return the custom vocabulary information for. The locale must be <code>en_GB</code>.

Success

botIdstring

The identifier of the bot that contains the custom vocabulary.

botVersionstring

The version of the bot that contains the custom vocabulary to describe.

localeIdstring

The locale that contains the custom vocabulary to describe.

customVocabularyStatus'Ready' | 'Deleting' | 'Exporting' | 'Importing' | 'Creating'

The status of the custom vocabulary. If the status is <code>Ready</code> the custom vocabulary is ready to use.

creationDateTimestring date-time

The date and time that the custom vocabulary was created.

lastUpdatedDateTimestring date-time

The date and time that the custom vocabulary was last updated.