SMsmartthings
Rooms

Update a Room

Update one or more fields of a specified Room. All fields in the request body are optional. Only the specified fields will be updated.

put/locations/{locationId}/rooms/{roomId}

Request

Request body

namestring required

A name for the room.

Example request

{
  "name": "Living Room",
  "indoorMap": {
    "mapRoomId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf8",
    "color": "some color code"
  }
}

Response

A Room.

roomIdstring uuid required

The ID of the room.

locationIdstring required

A unique location identifier. This is not guaranteed to be a valid UUID.

namestring required

A name for the room (e.g. Living Room)

backgroundImagestring

Not currently in use.

createdstring date-time

The timestamp of when a room was created in UTC.

lastModifiedstring date-time

The timestamp of when a room was last updated in UTC.

Example response

{
  "roomId": "bdd8a15f-33d4-41fc-b33c-75ce85e99d24",
  "locationId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf9",
  "name": "Living Room",
  "created": 1547920800,
  "lastModified": 1548007200,
  "indoorMap": {
    "mapRoomId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf8",
    "color": "some color code"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.