SMsmartthings
Preferences

Create a Preference Localization for a Locale

Changed on

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.

post/preferences/{preferenceId}/i18n

Request

Path parameters

preferenceIdstring required

The ID of the preference

Headers

Authorizationstring string required

OAuth token

Request body

tagstring required

The tag of the locale as defined in RFC bcp47.

labelstring required

A localized label for the Preference

descriptionstring

A localized description of the Preference

optionsobject

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.

Example request

{
  "tag": "en",
  "label": "Sensibilité au mouvement",
  "description": "Sensibilité au mouvement"
}

Response

Successful creation of a Preference Localization

tagstring required

The tag of the locale as defined in RFC bcp47.

labelstring required

A localized label for the Preference

descriptionstring

A localized description of the Preference

optionsobject

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.

Example response

{
  "tag": "en",
  "label": "Sensibilité au mouvement",
  "description": "Sensibilité au mouvement"
}

Changes