Skip to main content

@slack/web-api / UsergroupsUpdateArguments

Interface: UsergroupsUpdateArguments

Defined in: packages/web-api/src/types/request/usergroups.ts:43

Extends​

Properties​

channels?​

optional channels?: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:14

Description​

A comma separated string of encoded channel IDs for which the User Group uses as a default.

Inherited from​

UsergroupsCreateArguments.channels

description?​

optional description?: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:16

Description​

A short description of the User Group.

Inherited from​

UsergroupsCreateArguments.description

handle?​

optional handle?: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:18

Description​

A mention handle. Must be unique among channels, users and User Groups.

Inherited from​

UsergroupsCreateArguments.handle

include_count?​

optional include_count?: boolean;

Defined in: packages/web-api/src/types/request/usergroups.ts:6

Description​

Include the number of users in each User Group.

Inherited from​

UsergroupsCreateArguments.include_count

name?​

optional name?: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:12

Description​

A name for the User Group. Must be unique among User Groups.

Inherited from​

UsergroupsCreateArguments.name

team_id?​

optional team_id?: string;

Defined in: packages/web-api/src/types/request/common.ts:70

Description​

If using an org token, team_id is required.

Inherited from​

OptionalTeamAssignable.team_id

token?​

optional token?: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

usergroup​

usergroup: string;

Defined in: packages/web-api/src/types/request/usergroups.ts:48

Description​

The encoded ID of the User Group to update.