Remove User from Channel
- Print
- DarkLight
- PDF
Remove User from Channel
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/channels.kick
Remove a user from the channel.
Changelog
| Version | Description |
|---|---|
| 0.48.0 | Added |
Body parameters
Example 1
{
"roomId": "WDuJLFkjwk6L7LdFC",
"userId": "rYhzFRd2QZjNwAAXX"
}object
roomId
string Required
The channel's id
userId
string Required
The id of the user to be removed.
Responses
200
OK
Example
{
"channel": {
"_id": "ByehQjC44FwMeiLbX",
"name": "invite-me",
"t": "c",
"usernames": [
"testing1"
],
"msgs": 0,
"u": {
"_id": "aobEdbYhXfu5hkeqG",
"username": "testing1"
},
"ts": "2016-12-09T15:08:58.042Z",
"ro": false,
"sysMes": true,
"_updatedAt": "2016-12-09T15:22:40.656Z"
},
"success": true
}object
channel
object
_id
string
fname
string
customFields
object
topic
string
broadcast
boolean
encrypted
boolean
name
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
ts
string
ro
boolean
default
boolean
sysMes
boolean
_updatedAt
string
lastMessage
object
_id
string
rid
string
msg
string
ts
string
u
object
_id
string
username
string
name
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
lm
string
success
boolean
Was this article helpful?