---
title: "Create a Preference Localization for a Locale"
method: POST
path: "/preferences/{preferenceId}/i18n"
tags: ["Preferences"]
---

# Create a Preference Localization for a Locale

`POST /preferences/{preferenceId}/i18n`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/preferences/{preferenceId}/i18n`
- Auth: OAuth 2
  - Implicit: `https://auth-global.api.smartthings.com`
  - Scopes: `w:customcapabilities:*`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/preferences/:preferenceId/i18n/post.ts> (a function with typed inputs; its response is checked against the schema)

Add translated values in a desired language (i.e. locale) for a Preference.
The `locale` is the abbreviated internationalization code associated with the
language for which values will be stored. Translated values can include: preference title,
description, and enumeration option labels.

## Path parameters

- `preferenceId` string, required

## Headers

- `Authorization` string, string, required

## Request body

- PreferenceLocalization
  - `tag` string, required: The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt).
  - `label` string, required: A localized label for the Preference
  - `description` string: A localized description of the Preference
  - `options` object: Map of an option name to localizations. Options can only be provided to localize Enumeration type Preferences, and are required for Enumerations. The number of options in a Preference Localization must match the number of options in the Preference.

## Response `200`

Successful creation of a Preference Localization

- PreferenceLocalization
  - `tag` string, required: The tag of the locale as defined in [RFC bcp47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt).
  - `label` string, required: A localized label for the Preference
  - `description` string: A localized description of the Preference
  - `options` object: Map of an option name to localizations. Options can only be provided to localize Enumeration type Preferences, and are required for Enumerations. The number of options in a Preference Localization must match the number of options in the Preference.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `429`: Too many requests
- `default`: Unexpected error

## Changes

- **2023-11-27** `e8dd260a33ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smartthings/apis/smartthings-api/changes/preferences/:preferenceId/i18n/post.md)

---

[API](https://skmtc.dev/smartthings/apis/smartthings-api.md) - [All operations](https://skmtc.dev/smartthings/apis/smartthings-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartthings/apis/smartthings-api/revisions/2788a4236800?raw)