Create User
info
Basic API comes included with the Growth Plan
https://api.deadsimplechat.com/consumer/api/v1/user
Create User
This endpoint allows you to create a Chat Room User or a Chat Room Moderator, this API returns an accessToken for the user, which you can pass to the Chat Room to join the user to the Chat Room, refer the SSO using Auth Token Guide to learn more about how to implement it.
Create Users | Description | |
---|---|---|
Parameteres | ||
Query | ||
auth | string | API Private Key |
Body | ||
chatRoom | string | roomId 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 |
externalUserId | numberstring | UserId from your database you want to associate the user |
isModerator | boolean | default: false-If true the user will be the moderator of the chatRoom |
string | Email address you want to associated with the user | |
profilePic | string | URL of the profile pic you want to associate with the user, the URL should be https |
meta | string | Any metadata you want to pass to the user |
username | string | username of the user |
Responses
200
JSON
{
"accessToken": "eyJhbGcwOiJIUzI1NiIsInRscCI6IkpXVCJ9.eyJfaWQiOiI2MTQxZmQ4N2MzYjY3NTAzMTdkMDRmNjQiLCJ1c2VybmFtZSI6ImpvbiIsInBhcmVudEN1c3RvbWVyQWNjb3VudCI6IjVjYjcxY2RkODJiYTZiMDAwNDJmYjQzZiIsImNyZWF0ZWRVc2luZ0FwaSI6dHJ1ZSwiY2hhdFJvb20iOiI1ZjM5NzhlYWYzYjIzMDQ3ZmJmYWI3YTYiLCJpc01vZGVyYXRvciI6dHJ1ZSwiZXh0ZXJuYWxVc2VySWQiOiJ1bmRlZmluZWQiLCJjdXN0b21lciI6IjVjYjcxY2RkODJiYTZiMDAwNDJmYjQzZiIsImNyZWF0ZWQiOiIyMDIxLTA5LTE1VDE0OjA0OjU1Ljc1MFoiLCJ1cGRhdGVkIjoiMjAyMS0wOS0xNVQxNDowNDo1NS43NTBaIiwiX192IjowLCJpYXQiOjE2MzE3MTQ2OTV9.XYL5HexNgh8RsNQ2sAHU8wdOvFSSfJCOqzDqSU7n2as",
"username": "jon",
"userId": "6141fd87c3b6750317d04f64",
"isModerator": true
}