SMsmartthings
Modes

Change a Location's Current Mode

Changed on

Change a Location's current Mode. Note: This can cause enabled automations to run if the Location's Mode is an automation trigger.

put/locations/{locationId}/modes/current

Request

Request body

modeIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

Update the current Mode for this Location to the given Mode ID.

Example request

{
  "modeId": "9206ea57-2e2e-414c-a792-9087117ca3d8"
}

Response

Changed successfully.

idstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

Globally unique id for the Mode.

labelstring required

A user-readable label used to identify the mode in the app.

namestring ^[a-zA-Z0-9.-_]+$ required

An internal name for the Mode.

Example response

{
  "id": "9206ea57-2e2e-414c-a792-9087117ca3d8",
  "label": "Vacation",
  "name": "Home"
}

Changes