Yoto Developers
Update Shortcuts (beta)

Update Shortcuts (beta)

This endpoint is used to update the shortcuts configuration for a specific device identified by deviceId.

Request Body

The request body must be a JSON object structured as follows:

  • shortcuts: An object containing the modes for the shortcuts.

    • modes: An object that defines different modes.

      • day: An object representing the day mode.

        • content: An array of commands to be executed during the day. Each command is an object with:

          • cmd: A string representing the command type (e.g., "track-play").

          • params: An object containing parameters for the command:

            • card: A string representing the card identifier.

            • chapter: A string representing the chapter name.

            • track: A string representing the track key. For Yoto Daily, this can also equal , which will dynamically play the track for the current day.

      • night: An object representing the night mode.

        • content: An array of commands to be executed during the night (can be empty).

Required Scope

family:devices:manage

Responses

200 okapplication/json

No schema available for this response.

Body application/json

shortcutsobject

Path Parameters

deviceIdstringRequired
PUT
/device-v2/{deviceId}/shortcuts
Server URL: https://api.yotoplay.com
Request Body
curl "https://api.yotoplay.com/device-v2/{deviceId}/shortcuts"