Create Group

Prev Next
Post
/api/v1/groups.create

Create a new private channel, optionally including specified users. Refer to the Channels documents for information on the available room options.

The following permissions are required:

  • create-p: This permission is required to create a private channel.
  • create-team-group: This permission is required if you want to create a private channel from an existing team.

Changelog

Version Description
6.4.1 Added excludeSelf param
0.35.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
{
  "name": "groupname",
  "members": [
    "rocket.cat"
  ],
  "readOnly": true,
  "excludeSelf": true,
  "customFields": {
    "type": "default"
  },
  "extraData": {
    "broadcast": true,
    "encrypted": false,
    "teamId": "658441562dd9f928ad9951aa"
  }
}
Expand All
object
name
string Required

The name of the new private group.

readOnly
boolean

Set if the private channel is read-only or not. The default value is false.

members
Array of string

The users to add to the private channel when it is created.

string
excludeSelf
boolean

If set to true, the user calling the endpoint is not added as a member of the private channel. The default value is false.

customFields
object

If you have defined custom fields for your workspace, you can provide them in this object parameter.

extraData
object

Enter the following details for the object:

  • broadcast: Whether the group should be a broadcast group
  • encrypted: Whether the group should be encrypted.
  • teamId: Enter the team ID for which you want to create a group. You will get an error if the team does not exist.

For more information, see Channels.

Responses
200

OK

Success
{
  "group": {
    "_id": "NtR6RQ7NvzA9ejecX",
    "name": "testing",
    "t": "p",
    "msgs": 0,
    "u": {
      "_id": "aobEdbYhXfu5hkeqG",
      "username": "tester"
    },
    "ts": "2016-12-09T16:53:06.761Z",
    "ro": false,
    "sysMes": true,
    "_updatedAt": "2016-12-09T16:53:06.761Z"
  },
  "success": true
}
Expand All
object
group
object
_id
string
name
string
t
string
msgs
integer
u
object
_id
string
username
string
ts
string
ro
boolean
sysMes
boolean
_updatedAt
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string