Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Locales

Create a Locale

Creates a Locale in a Project.

post/v2.0/locales

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

namestring

The name of the Locale.

primaryboolean

If set to true, the Locale is the primary Locale for the Agent.

nluLanguage'ge-GE' | 'da-DK' | 'en-AU' | 'en-CA' | 'en-IN' | 'en-GB' | 'en-US' | 'de-DE' | 'ja-JP' | 'ko-KR' | 'es-ES' | 'nl-NL' | 'ar-AE' | 'fi-FI' | 'fr-FR' | 'it-IT' | 'nn-NO' | 'pl-PL' | 'sv-SE' | 'th-TH' | 'zh-CN' | 'vi-VN' | 'pt-BR' | 'ru-RU' | 'pt-PT' | 'tr-TR' | 'hi-IN' | 'bn-IN' | 'ta-IN'

The BCP 47 language tag used for NLU for this Locale.

fallbackLocaleReferencestring

The unique identifier for the fallback Locale.

projectIdstring

The unique identifier for the Project.

Example request

{
  "name": "English",
  "nluLanguage": "en-US"
}

Response

Returns Locale metadata object.

namestring

The name of the Locale.

primaryboolean

If set to true, the Locale is the primary Locale for the Agent.

nluLanguage'ge-GE' | 'da-DK' | 'en-AU' | 'en-CA' | 'en-IN' | 'en-GB' | 'en-US' | 'de-DE' | 'ja-JP' | 'ko-KR' | 'es-ES' | 'nl-NL' | 'ar-AE' | 'fi-FI' | 'fr-FR' | 'it-IT' | 'nn-NO' | 'pl-PL' | 'sv-SE' | 'th-TH' | 'zh-CN' | 'vi-VN' | 'pt-BR' | 'ru-RU' | 'pt-PT' | 'tr-TR' | 'hi-IN' | 'bn-IN' | 'ta-IN'

The BCP 47 language tag used for NLU for this Locale.

fallbackLocaleReferencestring

The unique identifier for the fallback Locale.

_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "name": "English",
  "nluLanguage": "en-US",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}