Sign in
Sites

Update supported comms locales

This endpoint allows you to update the list of locales that are supported by the site.

When a Customer has a preferred locale, if the locale is included in the site's supported comms locales, then any email communication will be sent in that preferred locale.

The locales must be included in the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.

put/shop/sites/{siteId}/supported-comms-locales

Path parameters

siteIdstring uuid required

Identifier of the site whose supported communication locales are being read or updated. The locales control which translations are selectable when authoring email/SMS templates and which locales customers may pick from at checkout.

Request body

localesstring[]

A list of locales that are supported by the site.

This should be a string of locale codes that are supported by the platform.

Example request

{
  "locales": [
    "en",
    "fr",
    "de"
  ]
}

Response

A list of supported comms locales

Example response

{
  "data": [
    {
      "code": "en",
      "name": "English",
      "emoji": "🇬🇧"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.