---
title: "Save company locale info"
method: PUT
path: "/api/v1/configuration/locale"
tags: ["System Configuration"]
---

# Save company locale info

`PUT /api/v1/configuration/locale`

Updates the locale (language and timezone) for the current company. This sets the default language and timezone for the system.

## Request body

- CompanyLocaleForm — Company locale settings (language and timezone)
  - `languageId` string, required — Java locale string
  - `timeZoneId` string, required — Java TimeZone ID

## Response `200`

Locale settings updated successfully

- ResponseEntityCompanyConfigView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` CompanyConfigView
    - `companyId` string, required — Company identifier
    - `companyName` string, required — Company display name
    - `portalURL` string, required — Portal URL for the dotCMS instance
    - `emailAddress` string, required — Company email address used as the system sender. May be a plain email or display name format (e.g. 'dotCMS Website <website@dotcms.com>')
    - `mx` string, required — Mail exchange domain for outgoing email
    - `primaryColor` string — Primary branding color (hex)
    - `secondaryColor` string — Secondary branding color (hex)
    - `backgroundColor` string — Background branding color (hex)
    - `backgroundImage` string — Background image path (dotAsset path starting with /dA)
    - `loginScreenLogo` string — Login screen logo path (dotAsset path starting with /dA)
    - `navBarLogo` string — Navigation bar logo path (dotAsset path starting with /dA, Enterprise only)
    - `authType` 'emailAddress' | 'userId', required — Authentication type: 'emailAddress' or 'userId'
    - `keyDigest` string — SHA-256 digest of the company security key (read-only, admin only)
    - `languageId` string — System default language as a Java locale string
    - `timeZoneId` string — System default timezone ID
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `400` — Invalid locale parameters (e.g. invalid timezone)
- `401` — Unauthorized - authentication required
- `403` — Forbidden - CMS Administrator role required

---

[API](https://skmtc.dev/jostens/apis/dotcms-rest-api.md) · [All operations](https://skmtc.dev/jostens/apis/dotcms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jostens/dotcms-rest-api/revisions/a088fe9f515c/schema)
