/usergroups.create - Slack Web API

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.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from usergroups.create method

enum<boolean>

required

Allowed value:

true

usergroup

object (Subteam/Usergroup Object)

required

auto_provision

boolean

required

auto_type

array [anyOf]

required

channel_count

integer

optional

created_by

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

date_create

integer

required

date_delete

integer

required

date_update

integer

required

deleted_by

array [anyOf]

required

description

string

required

enterprise_subteam_id

string

required

handle

string

required

string

required

Match pattern:

^S[A-Z0-9]{2,}$

is_external

boolean

required

is_subteam

boolean

required

is_usergroup

boolean

required

name

string

required

prefs

object

required

team_id

string

required

Match pattern:

^[T][A-Z0-9]{2,}$

updated_by

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

user_count

integer

optional

users

array[string]

optional

🔴500Typical error response