Settings 1.0

The Settings interface is used to manage Alexa settings on your product, such as locale.

Capability assertion

Settings 1.0 may be implemented by the device on its own behalf, but not on behalf of any connected endpoints.

Because Settings 1.0 is deprecated, Alexa will continue to support existing integrations using the Capabilities API, but new AVS integrations that use Alexa.Discovery may not use Settings 1.0.

{
    "type": "AlexaInterface",
    "interface": "Settings",
    "version": "1.0"
}

Events

SettingsUpdated

The SettingsUpdated event must be sent when Alexa settings are adjusted using on-product controls or a companion app. For example, your user may change their locale setting from US (en-US) to Germany (de-DE) using your companion app. When this happens, your client must notify Alexa of the change with the SettingsUpdated event.

Sample Message

{
    "event": {
        "header": {
            "namespace": "Settings",
            "name": "SettingsUpdated",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "settings": [
                {
                    "key": "{{STRING}}",
                    "value": "{{STRING}}"
                }
            ]
        }    
    }
}

Header Parameters

Parameter Description Type
messageId A unique ID used to represent a specific message. string

Payload Parameters

Parameter Description Type
settings A list of Alexa settings for a product. Each item in the list is an object with key/value pairs. list
key Identifies the key. Use the table below to identify accepted keys. string
value Identifies the key's value. Use the table below to identify accepted values for each key. string

Accepted Key/Value Pairs

Accepted Keys Accepted Values
locale de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, fr-CA, fr-FR, it-IT, ja-JP