This function updates details for a specified room identified by the roomid. The XML response will contain the updated room details. You should pass at least one parameter to be updated (roomname,promoteguests, etc.). You may pass multiple parameters at once to update multiple room details in one function call. Any parameters which aren't passed will remain unmodified.
Your api key
The id of the room to be edited.
The userid of the user that owns the room
The new name for the room.
A room password. If this is set then every user trying to enter the room will be prompted for it.
|integer||promoteguests||(optional) Default: 1.
If this is set to 1 and guests are allowed then guests to the room are automatically promoted to the role specified in promoterole (whch by default is Moderator 50)
|integer||promoterole||(optional) Default: Moderator (50).
If promoteguests is enabled then this is the role that the guests will be promoted to. IF nothing is specified and promoteguests is enabled then guests are automatically promoted to Moderator (5). Possible values are
Guests are anonymous users which are prompted for a username before entering
1=guests are allowed
0=guests are not allowed
|integer||clearassets||(optional) Default: 0.
Specifies if all the chat history and whiteboard contents should be cleared after a room times out. This happens a few minutes after the last user leaves a session. Uploaded assets will also be deleted at the same time.
1=assets and rooms contents are cleared after each session
0=assets and room contents persist
|integer||enablehistory||(optional) Default: 1.
Controls the chat history display.
1=enabled, chat messages persist within the room
0=disabed, no chat messages are persistent in the room
NOTE: if you update this property on an existing, live room then the new setting will not immediately be reflected in the room. It normally requires a room restart which happens automatically after the room has been empty for at least 40 minutes after which the updated room configuration is being reloaded.
Audio features enabled or disabled for this room.
Video features enabled or disabled for this room.
Text chat feature enabled or disabled for this room.
1=text chat enabled
0=text chat disabled
Provides Wolfram Alpha UI in the room if this feature is enabled on account level.
1=Wolfram Alpha enabled
0=Wolfram Alpha disabled
Allows you to hide the entire header section including logo and room name display to free up more space for the essential room features
1=hide header section
0=do not hide header section
|integer||hideuserlist|| Allows you to hide the userlist
1=hide the userlist
0=do not hide userlist
|integer||minimisesidepanel|| Allows you to start the room with a collapsed right hand side panel (holds audio, assets, chat, userlist). Users can still expand it if they wish.
1=load room with minimised right hand side panel
0=load room with normal, maximised right hand side panel
Allows you to hide the Flickr upload button from the Assets panel
1=hide flickr button
0=do not hide flickr button
Allows you to hide the stamp tool
1=hide stamp tool
0=do not hide stamp tool
When set to 1 will start the user's camera as soon as they enter the room (if video is enabled for this room)
1=autostart the webcam
0=do not autostart the webcam
When set to 1 will start the user's microphone as soon as they enter the room (if audio is enabled for this room)
1=autostart the microphone
0=do not autostart the microphone
Signals if this room is locked. A locked room can be entered but no changes can be made to its contents. Note: for a room lock to be successful you must also set allowlock to 1.
1=room is locked
0=room is not locked
Shows or hides the lock room button in the room and enables a room to be locked by a user.
1=room lock allowed, show lock button
0=room lock disabled, hide lock button
|integer||syncscalemode||(optional) Default: 0.
When set to 1, this room property will result in changes to the scalemode combobox to be synced across users. This means that if, for example, User A changes the scalemode to 'scrolling' then this setting is applied to all connected users.
Sample return XML
You may also receive one of the following error codes. This may happen for example if you try and update a user's emailaddress to one which is already assigned to another user.
|400||Generic error, check message for details|
|500||Internal server error, we have been notified and will investigate|
If no updateable parameter is passed (for example you only pass api_key and roomid but none of the other parameters):