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.

post

/v1/room/{id}/setActive

Path parameters

idstringrequired

Room streamId

Query parameters

activebooleanrequired

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/room/{id}/setActive?active=true' \
  --header 'sessionToken: text'

200

400

401

403

500

200

{
  "roomAttributes": {
    "name": "API room",
    "description": "Updated via the API",
    "membersCanInvite": true,
    "discoverable": true
  },
  "roomSystemInfo": {
    "id": "HNmksPVAR6-f14WqKXmqHX___qu8LMLgdA",
    "creationDate": 1461426797875,
    "createdByUserId": 7078106103809,
    "active": false
  },
  "immutableRoomAttributes": {
    "readOnly": false,
    "copyProtected": false,
    "public": false
  }
}

OK

🚧 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.