Put Update Chat Room

---

<button style={{ marginBottom: "10px" }} class="button button--outline button--active button--danger"> Put

https://api.deadsimplechat.com/consumer/api/v1/chatroom/:roomId

Put Update Chat Room

This endpoint allows you to update the chat room.

info

The auth query parameter is your private key. You can find it in your Dashboard under Developer -> Private Key.

Parameters		Description
Path
roomID	string	roomId of the chat room you want to update
Query
auth	string	Dashboard->Developer-> Private Key is your auth.
Body
customization	object	Customization of the chat room user interface. See Create Chat Room for the accepted keys.
translation	object	Translation strings for the chat room user interface. See loadTranslation for the accepted keys.
customCSS	string	Custom css you want to pass to the chat room
mainColor	string	Main colour of the chat room, as a CSS colour value (maximum length: 20)
sidebarColor	string	Colour of the chat room sidebar, as a CSS colour value (maximum length: 20)
hideInviteButton	string	"on" or "off". When "on" the invite button is hidden in the chat room.
defaultNotificationEnabled	string	"on" or "off". When "on" the notification sound is enabled by default, when "off" the notification sound is disabled by default.
fileSharingMode	string	blank, imageSharing or fileAndImageSharing. If blank then fileSharing is disabled. If imageSharing then only images can be shared in the chatRoom, fileAndImageSharing then images and files can be shared in the chatRoom.
enableChannels	string	"on" or "off". When "on", channels are enabled in the chatroom.
enableLikeMessage	string	"on" or "off". When "on" participants can like and react to messages.
moderatorOnlyOneToOneChat	string	"on" or "off". When "on" only moderators can have 1-1 chat with participants.
enableOneToOneChat	string	"on" or "off". When "on" then One to One Private Chat is enabled in the chatroom.
preModeratedChatRoom	string	"on" or "off". When "on" then Pre-Moderated Chat is enabled in the chat room.
roomPassword	string	If passwordProtected is turned on then roomPassword has to be specified. If passwordProtected is turned off then this property has no effect.
passwordProtected	string	on or off
description	string	description of the chat room
name	string	name of the chatroom
metadata	string	metadata of the chat room (maxlength: 1000)

info

Unlike Create Chat Room, this endpoint does not accept chatRoomPermissionLevel. Sending it returns a 400 validation error.

Responses

200

JSON

{
    "success": true,
    "roomId": "MUn5FkFjb",
    "url": "https://deadsimplechat.com/MUn5FkFjb"
}

400

JSON

{
    "error": {
        "_original": {
            "name": "cool chat room",
            "passwordProtected": true
        },
        "details": [
            {
                "message": "\"passwordProtected\" must be one of [on, off, false]",
                "path": [
                    "passwordProtected"
                ],
                "type": "any.only",
                "context": {
                    "valids": [
                        "on",
                        "off",
                        false
                    ],
                    "label": "passwordProtected",
                    "value": true,
                    "key": "passwordProtected"
                }
            }
        ]
    }
}