Skip to main content

Put Update Chat Room


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.

ParametersDescription
Path
roomIDstringroomId of the chat room you want to update
Query
authstringDashboard->Developer-> Private Key is your auth.
Body
roomPasswordstringIf passwordProtected is turned on then roomPassword has to be specified. If passwordProtected is turned off then this property has no effect.
descriptionstringdescription of the chat room
namestringname of the chatroom
metadatastringmetadata of the chat room (maxlength: 1000)

Responses

200

JSON

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

404

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"
}
}
]
}
}