/usergroups.create
POST
/usergroups.createCreate a User Group
Request
Header Params
token
string
required
Authentication token. Requires scope: usergroups:write
Body Params application/x-www-form-urlencoded
channels
string
optional
A comma separated string of encoded channel IDs for which the User Group uses as a default.
description
string
optional
A short description of the User Group.
handle
string
optional
A mention handle. Must be unique among channels, users and User Groups.
include_count
string
optional
Include the number of users in each User Group.
name
string
required
A name for the User Group. Must be unique among User Groups.
Request samples
Responses
Typical success response(200)
Typical error response(500)
Typical success response
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
ok
#/definitions/700149required
usergroup
#/definitions/700169required
Exampleresponse
{
"ok": true
}
Last modified: a year ago