Create a User Group
Method URL: | https://slack.com/api/usergroups.create |
||||||
---|---|---|---|---|---|---|---|
Preferred HTTP method: | POST |
||||||
Accepted content types: | application/x-www-form-urlencoded , application/json |
||||||
Rate limiting: | Tier 2 | ||||||
Works with: |
|
This method is used to create a User Group.
Argument | Example | Required | Description |
---|---|---|---|
token | xxxx-xxxxxxxxx-xxxx |
Required | Authentication token bearing required scopes. |
name | My Test Team |
Required | A name for the User Group. Must be unique among User Groups. |
channels | C1234567890,C2345678901,C3456789012 |
Optional | A comma separated string of encoded channel IDs for which the User Group uses as a default. |
description | Optional | A short description of the User Group. |
|
handle | marketing |
Optional | A mention handle. Must be unique among channels, users and User Groups. |
include_count | true |
Optional | Include the number of users in each User Group. |
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
If successful, the command returns a usergroup object, including preferences:
{
"ok": true,
"usergroup": {
"id": "S0615G0KT",
"team_id": "T060RNRCH",
"is_usergroup": true,
"name": "Marketing Team",
"description": "Marketing gurus, PR experts and product advocates.",
"handle": "marketing-team",
"is_external": false,
"date_create": 1446746793,
"date_update": 1446746793,
"date_delete": 0,
"auto_type": null,
"created_by": "U060RNRCZ",
"updated_by": "U060RNRCZ",
"deleted_by": null,
"prefs": {
"channels": [
],
"groups": [
]
},
"user_count": "0"
}
}
This table lists the expected errors that this method could return.
However, other errors can be returned in the case where the service is down
or other unexpected factors affect processing. Callers should always
check the value of the ok
params in the response.
Error | Description |
---|---|
permission_denied |
The user does not have permission to create a User Group. |
not_authed |
No authentication token provided. |
invalid_auth |
Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
account_inactive |
Authentication token is for a deleted user or workspace. |
token_revoked |
Authentication token is for a deleted user or workspace or the app has been removed. |
no_permission |
The workspace token used in this request does not have the permissions necessary to complete the request. |
org_login_required |
The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
user_is_bot |
This method cannot be called by a bot user. |
user_is_restricted |
This method cannot be called by a restricted user or single channel guest. |
invalid_arg_name |
The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg |
The method was passed a PHP-style array argument (e.g. with a name like |
invalid_charset |
The method was called via a |
invalid_form_data |
The method was called via a |
invalid_post_type |
The method was called via a |
missing_post_type |
The method was called via a |
team_added_to_org |
The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
request_timeout |
The method was called via a |
fatal_error |
The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |