---
title: "Add All Users to Group"
slug: "add-all-users-to-group"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/add-all-users-to-group"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Add All Users to Group

Post/api/v1/groups.addAll

Add all workspace users to the private channel. You can do this if you are a member of the private channel or have admin permissions.

### Changelog

| Version | Description |
| --- | --- |
| 0.55.0 | Added |

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters<select class='api-response-data' aria-label='Media type'><option value='6e72a63d-9de6-4915-a644-d8b29e4aae72'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='4871e1ae-8b48-441b-a594-e1d7a0362a3b'>Example</option>
</select>Example

```json
{
  "roomId": "ByehQjC44FwMeiLbX",
  "activeUsersOnly": true
}
```

object  roomIdstring    Required

Enter the group ID. Alternatively, you can enter the name using the `roomName` query parameter. You can find the IDs by using any of the following endpoints:

- [Get List of User Groups](https://developer.rocket.chat/apidocs/get-list-of-user-groups): This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- [Get Groups](https://developer.rocket.chat/apidocs/get-groups): This endpoint returns the private channels that you are a member of.

activeUsersOnlyboolean    

Add only active users to the room.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='12d19555-3923-47ab-8a7c-ffef281f1848'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='2062bc4d-3075-4484-a401-b957ef6447fb'>Success</option>
</select>Success

```json
{
  "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
}
```

Expand Allobject  channelobject  _idstring    
namestring    
tstring    
usernames Array of string   string    
msgsinteger    
uobject  _idstring    
usernamestring    

tsstring    

successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='6d8f270e-9b3f-4dd4-a86f-20edad4993de'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='244e142a-e697-4f5c-8cd8-acb5dee0b1ea'>Example 1</option>
</select>Example 1

```json
{
  "success": false,
  "error": "The required \"roomId\" or \"roomName\" param provided does not match any group [error-room-not-found]",
  "errorType": "error-room-not-found"
}
```

object  successboolean    
errorstring    
errorTypestring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='040430f0-ddf4-4005-86bb-5c8e5658f6f5'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='5e200c3e-cb81-48f8-b904-ff2a181911d2'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring