Skip to main content

Update User

info

Basic API comes included with the Growth Plan


https://api.deadsimplechat.com/consumer/api/v1/user

Update User

This endpoint allows you to update an existing chat room user. Specify the userId field in the body of the request.

Create UsersDescription
Parameteres
Query
authstringSecret Key
Body
userIdrequired (string)userId of the user you would like to update.
chatRoomstringroomId of the chatRoom you want to link the user to. When creating a moderator if chatRoom is passed then the user will be the moderator of the specified chatRoom, if chatRoom is not specified then the user will be the moderator of all the chatRooms
externalUserIdnumberstringUserId from your database you want to associate the user
isModeratorbooleandefault: false-If true the user will be the moderator of the chatRoom
emailstringEmail address you want to associated with the user
profilePicstringURL of the profile pic you want to associate with the user, the URL should be https
metastringAny metadata you want to pass to the user
usernamestringusername of the user

Responses

200

JSON

{
"accessToken": "eyJhbGcwOiJIUzI1NiIsInRscCI6IkpXVCJ9.eyJfaWQiOiI2MTQxZmQ4N2MzYjY3NTAzMTdkMDRmNjQiLCJ1c2VybmFtZSI6ImpvbiIsInBhcmVudEN1c3RvbWVyQWNjb3VudCI6IjVjYjcxY2RkODJiYTZiMDAwNDJmYjQzZiIsImNyZWF0ZWRVc2luZ0FwaSI6dHJ1ZSwiY2hhdFJvb20iOiI1ZjM5NzhlYWYzYjIzMDQ3ZmJmYWI3YTYiLCJpc01vZGVyYXRvciI6dHJ1ZSwiZXh0ZXJuYWxVc2VySWQiOiJ1bmRlZmluZWQiLCJjdXN0b21lciI6IjVjYjcxY2RkODJiYTZiMDAwNDJmYjQzZiIsImNyZWF0ZWQiOiIyMDIxLTA5LTE1VDE0OjA0OjU1Ljc1MFoiLCJ1cGRhdGVkIjoiMjAyMS0wOS0xNVQxNDowNDo1NS43NTBaIiwiX192IjowLCJpYXQiOjE2MzE3MTQ2OTV9.XYL5HexNgh8RsNQ2sAHU8wdOvFSSfJCOqzDqSU7n2as",
"username": "jon",
"userId": "6141fd87c3b6750317d04f64",
"isModerator": true
}