Skip to main content
PATCH
/
v2
/
locales
/
{localeIdOrCode}
Update Locale
curl --request PATCH \
  --url https://api.makeswift.com/v2/locales/{localeIdOrCode} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "locale": "es-ES",
  "domain": "https://hearthfurniture.com.mx",
  "pathPrefix": "french"
}
'
{
  "object": "locale",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locale": "<string>",
  "domain": "https://hearthfurniture.com.mx",
  "pathPrefix": "french",
  "isDefault": true
}

Authorizations

​
x-api-key
string
header
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)

Path Parameters

​
localeIdOrCode
string
required

The locale ID or locale code.

Query Parameters

​
siteId
string<uuid>

The site ID required when using a locale code instead of a locale ID.

Body

application/json
​
locale
string

Locale of the site locale.

Example:

"es-ES"

​
domain
string<uri> | null

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

Example:

"https://hearthfurniture.com.mx"

​
pathPrefix
string | null

Custom URL path prefix for this locale. Strip leading/trailing slashes before sending. Null means the locale code is used as the prefix (default behavior).

Example:

"french"

Response

​
object
enum<string>
required
Available options:
locale
Example:

"locale"

​
id
string<uuid>
required

The ID of the updated locale.

​
locale
string
required

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

Examples:

"en"

"es"

"fr-FR"

"ar-EG"

"ja-JP"

​
domain
string<uri> | null
required

The domain URL for domain-based localization.

Example:

"https://hearthfurniture.com.mx"

​
pathPrefix
string | null
required

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

Example:

"french"

​
isDefault
boolean
required

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