De/Re-activate Room

Deactivate or reactivate a chatroom. At creation, a new chatroom is active.

Deactivate or reactivate a chatroom. At creation, a new chatroom is active.

POSTyourpodURL.symphony.com/pod/v1/room/{id}/setActive

Path parameters

id*string

Room streamId

Query parameters

Header parameters

Response

200400401403500

OK

Body

application/json

roomAttributesRoomAttributes (object)

roomSystemInfoRoomSystemInfo (object)

immutableRoomAttributesImmutableRoomAttributes (object)

These attributes cannot be changed once the room has been created

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/room/{id}/setActive?active=false', {
    method: 'POST',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403500

{
  "roomAttributes": {
    "name": "text",
    "description": "text",
    "membersCanInvite": false,
    "discoverable": false
  },
  "roomSystemInfo": {
    "id": "bjHSiY4iz3ar4iIh6-VzCX___peoM7cPdA",
    "creationDate": 1547661232368,
    "createdByUserId": 14362370637825,
    "active": true
  },
  "immutableRoomAttributes": {
    "public": false,
    "readOnly": false,
    "copyProtected": false
  }
}

🚧 Rules and limitations

Only rooms with members can be reactivated

📘 Room ID

The room ID can be located in the Symphony web or desktop client by clicking on the timestamp of any message in the conversation. This will open the Message Status module overlay, and the Conversation ID can be found in the overlay footer.

The room ID in the UI is in Standard Base64 encoding. When the room ID needs to be used in a URL, it should be in URLSafe Base64 encoding. To obtain the URLSafe Base64 room ID, replace forward slashes with underscores, replace pluses with minuses, and ignore any trailing equal signs.

See Overview of Streams for details.

🚧 Required Permissions

External Rooms that have not been created by your company cannot be de/re-activated. Rooms can only be de/re-activated by:

• Owners of the room

• Compliance Officers and Super Compliance Officers who are not members of the room

• Service Users with the User Provisioning role (members or not members of the room)

See Bot Permissions for a list of roles and associated privileges.