Update Room

Update the attributes of an existing chatroom.

post

Path parameters

idstringRequired

Room streamId

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

namestringOptional

Room name.

Example: API room

descriptionstringOptional

Room description.

Example: Created via the API

membersCanInvitebooleanOptional

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

Example: true

discoverablebooleanOptional

If true, this chatroom (name, description and messages) can be searched and listed by non-participants. If false, only participants can search this room.

publicbooleanOptional

If true, this is a public chatroom. IF false, a private chatroom.

readOnlybooleanOptional

If true, only stream owners can send messages.

copyProtectedbooleanOptional

If true, clients disable the clipboard copy for content in this stream.

crossPodbooleanOptional

If true, this room is a cross pod room

viewHistorybooleanOptional

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

multiLateralRoombooleanOptional

If true, this is a multi lateral room where we can find users belonging to more than 2 companies.

scheduledMeetingbooleanOptional

If true, this room is for a scheduled meeting.

subTypestringOptional

This field is ignored when creating a new room as it was only used for email integration which is now sunset.

pinnedMessageIdstringOptional

UrlSafe message id of the pinned message inside the room. To perform unpin operation, send an empty string.

Example: vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ

groupChatbooleanOptional

If true, this room is a group chat. Note: this parameter is ignored for creating rooms. Since SBE 20.16.

Responses

200

OK

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

451

Unavailable for Legal Reasons: Compliance Issues found in room update request.

application/json

500

Server error, see response body for further details.

application/json

post

/v3/room/{id}/update

HTTPcURLJavaScriptPython

POST /pod/v3/room/{id}/update HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "name": "API room",
  "keywords": [
    {
      "key": "region",
      "value": "EMEA"
    },
    {
      "key": "lead",
      "value": "Daffy Duck"
    }
  ],
  "description": "Created via the API",
  "membersCanInvite": true,
  "discoverable": false,
  "public": false,
  "readOnly": false,
  "copyProtected": false,
  "crossPod": false,
  "viewHistory": false,
  "multiLateralRoom": false,
  "scheduledMeeting": false,
  "subType": "text",
  "pinnedMessageId": "vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ",
  "groupChat": false
}

{
  "roomAttributes": {
    "name": "API room",
    "keywords": [
      {
        "key": "region",
        "value": "EMEA"
      },
      {
        "key": "lead",
        "value": "Daffy Duck"
      }
    ],
    "description": "Created via the API",
    "membersCanInvite": true,
    "discoverable": false,
    "public": false,
    "readOnly": false,
    "copyProtected": false,
    "crossPod": false,
    "viewHistory": false,
    "multiLateralRoom": false,
    "scheduledMeeting": false,
    "subType": "text",
    "pinnedMessageId": "vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ",
    "groupChat": false
  },
  "roomSystemInfo": {
    "id": "bjHSiY4iz3ar4iIh6-VzCX___peoM7cPdA",
    "creationDate": 1547661232368,
    "createdByUserId": 14362370637825,
    "active": true
  },
  "groups": [
    {
      "id": 68719476744,
      "addedBy": 68719476743
    }
  ]
}

An error will be returned if no attributes are changed or if one attribute cannot be changed, based on the Attributes rules listed below.

🚧 Attributes rules

• The room attributes associated with the room type are all read-only and cannot be changed: public, crossPod, multiLateral

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

• discoverable : This attribute cannot be true for crossPod rooms, and cannot be false for public rooms.

• membersCanInvite This attribute cannot be false for public rooms.

• viewHistory: This attribute can be changed only if the calling user is a room owner; or if the calling user has the entitlement "Can Toggle Room's Share History Property".

• subType: This attribute is deprecated and cannot be changed.

📘 Note - Pinned message

The pinnedMessageId attribute allows to display an exact copy of the original message in a pinned area placed beneath the chat header and that remains always visible to all users. From this area, they can interact with the message content (i.e. forms or ui actions buttons), and they are able to automatically jump to the original message in the chat canvas. You can use this attribute as follows:

• Either by entering the URLSafe Base 64 ID of the message you wish to pin beneath the chat header (as you can see in the example). Even if another message is pinned, this new message will replace it in the pinned area;

• Either by entering an empty value to upin any message and remove therefore this area from being visible to users as follows: "pinnedMessageId": "";

• Please note that these actions (pin/unpin) can also be performed by end users when they are owners of the room.

📘 Note - Groups

The groups object is added in the response payload only if at least a Group has been added to the room. It is an array containing:

• id attribute: ID of the Group,

• addedBy: ID of the user who added the Group to the room

See Groups for more information.

🚧 Required Permissions

Rooms can only be updated by owners of the room. See Bot Permissions for a list of roles and associated privileges.

📘 Stream ID

The stream 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 stream ID in the UI is in Standard Base64 encoding. When the stream ID needs to be used in a URL, it should be in URLSafe Base64 encoding. To obtain the URLSafe Base64 stream ID, replace forward slashes with underscores, replace pluses with minuses, and ignore any trailing equal signs.

Note: visit Overview of streams for more information.