Update available locales and/or the system default locale.

patch

https://example.com/settings/v1/locales/configuration

Locale codes are lowercase formatted and using '-' between country code and language, for example: 'en-us'.
If the availableLocales was provided it must contain the system locale en-us because it cannot be removed.
IF 'defaultLocale' was provided it must be exist in the availableLocales list.
If availableLocales is not provided the default locale must be exist before setting it as default

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
availableLocales	object	false
availableLocales.present	boolean	false
defaultLocaleCode	string	false	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us

This API requires SETTINGS_UPDATE_LOCALES permission(s).

Body Params

availableLocales

array of objects

length between 1 and 2147483647

availableLocales

code

string

required

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

hidden

boolean

translationFallbackTypes

array of strings

Valid array values: DEFAULT_LOCALE,SYSTEM_LOCALE. Allow to control the fallback mechanism. If not provided(null) then the default behavior is the following fallback order: -> DEFAULT_LOCALE -> SYSTEM_LOCALE. The recommended value is null. When all of the fallback types return an empty value, no translation will be made, i.e. the original value will be retained

translationFallbackTypes

Allowed:

defaultLocaleCode

string

Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

Responses

Parameter	Type	Description	Example
availableLocales	array
availableLocales[index]	array
availableLocales[index].code	string	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
availableLocales[index].hidden	boolean		false
availableLocales[index].translationFallbackTypes	array	Valid array values: DEFAULT_LOCALE,SYSTEM_LOCALE. Allow to control the fallback mechanism. If not provided(null) then the default behavior is the following fallback order: -> DEFAULT_LOCALE -> SYSTEM_LOCALE. The recommended value is null. When all of the fallback types return an empty value, no translation will be made, i.e. the original value will be retained
defaultLocaleCode	string	Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
systemLocaleCode	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Code : DEFAULT_LOCALE_NOT_IN_AVAILABLE_LOCALES, Details: [] Code : DEFAULT_LOCALE_NOT_EXIST, Details: [] Code : DELETE_SYSTEM_LOCALE_NOT_ALLOWED, Details: []

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []