Locale

Last updated: June 22, 2026

A Locale is a language setting that a Space supports. Each Locale has a language code (code, e.g. ko-KR), whether it is the Space's default Locale (default), whether it is optional when filling required fields (optional), and the Locale to look up instead when a value is missing (fallbackCode). The CDA (Content Delivery API) delivers this list read-only. Creating or editing a Locale is the responsibility of CMA Locale.

The locale query parameter value you pass when reading Content or Media is exactly this Locale's code. To find out which codes you may use, first read the list of Locales a Space supports through this endpoint, then use the code values it contains.

Resource structure

The following is how CDA delivers one Locale from the demo Space ("English (United States)"). Along with sys (system properties), it has optional, the Locale's body property.

{
  "sys": {
    "id": "3trmXRM3RqbgSnifyg7PAlm5PVgE8o",
    "type": "Locale",
    "space": { "sys": { "id": "tcq4V2Xb", "type": "Refer", "targetType": "Space" } },
    "name": "English (United States)",
    "default": true,
    "code": "en-US",
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-06-17T16:21:10.310Z",
    "updatedAt": "2026-06-17T16:21:10.310Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "version": 1
  },
  "optional": false
}

Key properties:

  • sys.code: The language code of this Locale. You put this value into the locale parameter when reading Content or Media.
  • sys.default: Whether this Locale is the Space's default Locale. A Space has one default Locale, and default is true only on that Locale.
  • sys.name: The human-readable name (e.g. "English (United States)"). In query parameters you use code, not this name.
  • optional: Whether you may leave this Locale empty when filling a required field. Both Locales in the list example below have optional set to false.
  • fallbackCode: The code of another Locale to look up instead when a value is missing (optional). It appears in the response only when it is set. It is not set on the Locale above, so the key is not shown.

System properties (sys) and body

space, createdBy, and updatedBy come in the Refer shape ({ "sys": { "id", "type": "Refer", "targetType" } }).

PropertyTypeDescription
idstringUnique resource identifier.
typestringResource kind. For a Locale this is always "Locale".
spaceRefer<Space>The Space this Locale belongs to.
namestringHuman-readable name (e.g. "English (United States)").
codestringLanguage code (e.g. ko-KR). Becomes the locale value when reading Content or Media.
defaultbooleanWhether it is the Space's default Locale. Only one in a Space is true.
createdByRefer<User>The user who created it.
createdAtstring (date-time)Creation time.
updatedByRefer<User>The user who last updated it.
updatedAtstring (date-time)Last update time.
versionintegerThe current version. It increases each time the resource is updated.

Because a Locale is a Space setting resource rather than a published snapshot, the revision, status, and publish found in a Content's sys are not carried.

Body properties:

PropertyTypeDescription
optionalbooleanWhether you may leave this Locale empty when filling a required field. The default Locale is usually false (must be filled).
fallbackCodestringThe code of the Locale to look up instead when a value is missing (optional, chainable). If it is not set, the key itself is absent from the response.

Behavior notes

A Locale whose default is true must be filled when creating Content, and when reading Content or Media you resolve values by specifying locale as that code. If fallbackCode is set, then when the requested Locale has no value, the lookup moves to the Locale that fallbackCode points to (and if that Locale also has a fallbackCode, the chain continues). A Locale with no fallbackCode returns null as is when a value is missing. The default Locale, fallback, and required-fill rules are covered in Localization (concept).

API

The base URL for the endpoint below is https://cda.weegloo.com/v1, and a Bearer token that authenticates against CDA is required in the Authorization header. Because the Locale list is the language setting itself, unlike reading Content or Media it does not take a locale query parameter.