Add All Users to Group
- Print
- DarkLight
- PDF
Add All Users to Group
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/groups.addAll
Adds all of the users of the Rocket.Chat workspace to the group/channel.
Changelog
| Version | Description |
|---|---|
| 0.55.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"roomId": "ByehQjC44FwMeiLbX",
"activeUsersOnly": "true"
}object
roomId
string Required
The group id
activeUsersOnly
string
Adds all of the users of the Rocket.Chat workspace to the group/channel.
Responses
200
OK
Success
{
"channel": {
"_id": "ByehQjC44FwMeiLbX",
"name": "groupname",
"t": "p",
"usernames": [
"example",
"rocket.cat"
],
"msgs": 0,
"u": {
"_id": "aobEdbYhXfu5hkeqG",
"username": "example"
},
"ts": "2016-05-30T13:42:25.304Z"
},
"success": true
}object
channel
object
_id
string
name
string
t
string
usernames
Array of string
string
msgs
integer
u
object
_id
string
username
string
ts
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?