Create

Create

Create

Adds a room to an account.

Request

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

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

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

room is required, cannot be empty, and cannot exceed 32 characters.
Room labels must be unique per account. Attempting to create a room with a label that already exists for the account will fail with a 409 conflict.
This table has no active/deactivation concept. Rooms are only ever hard-deleted — there is no inactive or soft-deleted state for a row on this table.

Response

Headers

Location — the URL of the newly created room.

Status Code

Code
Description
201 Created
The room was created.
400 Bad Request
The room was not created. 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.
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.