SMsmartthings
Preferences

Update a Preference Localization for a Locale

Changed on

Update existing 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 updated.<br/><br/> If the tag argument is provided in the request body, it will be ignored.

put/preferences/{preferenceId}/i18n/{locale}

Request

Path parameters

preferenceIdstring required

The ID of the preference

localestring required

The tag of the locale as defined in RFC bcp47.

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 update 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