Update cPanel account locale

This function sets the account's locale.

Authorizations:
query Parameters
locale
required
string

The locale's abbreviated name according to UAPI's Locale::list_locales function.

Example: locale=en

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Locale \
  set_locale \
  locale='en'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "set_locale",
  • "module": "Locale",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}