Add All Users to Group
    • Dark
      Light
    • PDF

    Add All Users to Group

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/groups.addAll

    Adds all of the users of the Rocket.Chat workspace to the group/channel.

    Changelog

    VersionDescription
    0.55.0Added
    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 1
    {
      "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

    Example 1
    {
      "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 All
    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

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.