Update

Update

Update

Updates an existing room on an account.

Request

Method
URL
PUT
 https://api.solatech-dos.com/lists/v1/accounts/{accountUniqueId}/rooms/{itemUniqueId} 

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the room.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
room

Text
The label of the room. Must not be empty and must be 32 characters or fewer.
{
  "room": "Living Room"
}

Remarks

Unlike tables with an Active column, rooms have only one mutable field, so it is required on update just as it is on create — there's no partial/omit-to-leave-unchanged behavior here. The full label must be supplied on every update.
Room labels must still be unique per account when a new room value is supplied.

Response

Headers

None

Status Code

Code
Description
200 OK
The updated room was returned.
400 Bad Request
The room was not updated. This occurs if room is missing, empty, or longer than 32 characters.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API keys feature enabled, or the key does not have the required scope.
404 Not Found
No room was found with that id for this account.
409 Conflict
A room with that name already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the room.
room
Text
The label of the room.