Room Attributes

Rooms are specified by name, description, optional keywords, and a variety of settings, such as whether all participants can invite new participants or whether the room is accessible for anyone to join.

The following attributes apply to these Room endpoints:

Name

Type

Description

name

string

Room name

description

string

Room description

keywords

array

A list of key-value pairs, describing additional properties of the room. It is possible to search rooms by keyword values using the Search Rooms endpoint.

membersCanInvite

boolean

If true, any chat room participant can add new participants.
If false, only owners can add new participants.

discoverable

boolean

If true, this chat room (name, description and messages) non-participants can search for this room.
If false, only participants can search for this room.

public

boolean

If true, this is a public chatroom and anyone can join.
If false, this is a private chatroom and participants must be added.

readOnly

boolean

If true, only room owners can send messages.

copyProtected

boolean

If true, users cannot copy content from this room.

crossPod

boolean

If true, this room is a cross pod room.

viewHistory

boolean

If true, new members can view the room chat history of the room.

multiLateralRoom

boolean

If true, this is a multilateral room where users belonging to more than two companies can be found.

pinnedMessageId

string

URLSafe Base64 ID of the pinned message.

🚧

Copy Protection

Once set to true, copyProtected cannot be set to false. Copy protection can be added to a room but cannot be removed.

📘

Overview of streams

A stream is like a container for messages exchanged between two or more users via a given instant message (IM), multi-party instant message (MIM), or chat room. For more information, refer to Overview of streams.