SAsalesforce
roomTypes

Get roomType

Changed on
get/roomTypes/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/roomTypes/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the roomType to retrieve

Query parameters

activeboolean

Get roomTypes depending on its active tag

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns specified roomType

idstring

The UUID of the roomType specified

namestring

The roomType being used in the specified room

isEnabledboolean

Flag indicating whether a roomType is enabled to use on rooms

settingsobject

Key-value pairs used to configure bots and rooms intial state

rulesobject[]

Array containing the rules that trigger automations for rooms of this type

botsstring[]

Array containing the bots to be used for rooms of this type

createdBystring

Id of the User who created this roomType.

Changes