Capabilities

Patch a Capability Localization by Locale

Modify specific values of existing language (i.e. locale) translations for a Capability. The locale is the abbreviated, internationalization code associated with the language for which values will be modified.<br /><br /> All fields in the request body are optional. Any fields populated will replace existing localization values. Any fields left blank will fall back to existing values.

patch/capabilities/{capabilityId}/{capabilityVersion}/i18n/{locale}

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesw:customcapability
TypeScript
https://skmtc.dev/smartthings/apis/smartthings-api/docs/capabilities/:capabilityId/:capabilityVersion/i18n/:locale/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

tagstring required

The tag of the locale as defined in RFC bcp47.

labelstring

A localized label for the capability

descriptionstring

A localized description of the capability

attributesobject

Map of attribute name to localizations

commandsobject

Map of command name to localizations

Example request

{
  "tag": "en",
  "label": "Modo de ar condicionado",
  "description": "Modo de ar condicionado",
  "attributes": {
    "airConditionerMode": {
      "displayTemplate": "é suposto {{device.label}} a palavra {{attribute}} igual a {{value}}.",
      "label": "Este é o modo de ar condicionado",
      "i18n": {
        "value": {
          "auto": {
            "label": "Auto",
            "description": "Este é o modo automático"
          },
          "cool": {
            "label": "Frio",
            "description": "Este é o modo frio"
          }
        }
      }
    }
  },
  "commands": {
    "setAirConditionerMode": {
      "arguments": {
        "mode": {
          "i18n": {
            "auto": {
              "label": "Auto"
            },
            "cool": {
              "label": "Frio"
            }
          }
        }
      }
    }
  }
}

Response

successful patch of a Capability localization