Sign in

v1

latestOpenAPI 3.1.02026-08-04177151.5 KB
locale

Create Locale

Creates a new locale for a site.

post/v2/locales

Headers

x-api-keystring required

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Request body

siteIdstring uuid required

The site ID to create the locale for.

localestring required

Locale of the site locale.

domainstring uri

The domain URL for domain-based localization. This URL must include the protocol.

Response

object'locale' required
idstring uuid required

The ID of the created locale.

localestring required

We support the subset of locales specified with ISO 3166 that are composed of language and optionally a region.

domainstring uri nullable required

The domain URL for domain-based localization.

pathPrefixstring nullable required

Custom URL path prefix. Null means the locale code is used as the default prefix.

isDefaultboolean required

The flag that indicates whether this locale is the default locale for the site.