SAsalesforce
roomTypes

Create roomType

Create a new roomType with a name

post/roomTypes

Request

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

Request body

namestring required

Name of the roomType

isEnabledboolean

If the roomType is active

settingsobject

Default settings for roomType

rulesobject[]

Default rules for roomType

botsstring[]

Default bots for roomType

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Created 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

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