Documentation

Save Room Settings

Requirements

| Logged In | Permission | Setting | | — | — | — | | Yes | edit-room | none |

Payload

  1. String - the id of the room to leave
  2. String - the room setting to save
  3. Any - the value of the setting to save, this value type depends on what the setting accepts

Available Settings

| Setting | Accepted Values | | — | — | | roomName | String | | roomTopic | String | | roomDescription | String | | roomType | c or p | | readOnly | Boolean | | systemMessages | Boolean | | default | Boolean | | joinCode | String |

Example Call

{
    "msg": "method",
    "method": "saveRoomSettings",
    "id": "16",
    "params": [
        "roomId",
        "setting",
        "value"
    ]
}

Example Response

{
    "msg": "result",
    "id": "16",
    "result": {
        "result": true,
        "rid": "roomId"
    }
}

See Also