---
title: "RichTextUsergroupMention"
summary: "@slack/web-api / RichTextUsergroupMention"
url: "https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/RichTextUsergroupMention"
type: "guide"
---

Source: https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/RichTextUsergroupMention

[@slack/web-api](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api.md) / RichTextUsergroupMention

# Interface: RichTextUsergroupMention

Defined in: packages/types/dist/block-kit/block-elements.d.ts:864

## Description {#description}

A usergroup mention element for use in a rich text message.

## Extends {#extends}

*   [`RichTextStyleable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/richtextstyleable.md)

## Properties {#properties}

### style? {#style}

```
optional style?: object;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:75

#### bold? {#bold}

```
optional bold?: boolean;
```

##### Description {#description-1}

When `true`, boldens the text in this element. Defaults to `false`.

#### code? {#code}

```
optional code?: boolean;
```

##### Description {#description-2}

When `true`, the text is preformatted in an inline code style. Defaults to \`false.

#### italic? {#italic}

```
optional italic?: boolean;
```

##### Description {#description-3}

When `true`, italicizes the text in this element. Defaults to `false`.

#### strike? {#strike}

```
optional strike?: boolean;
```

##### Description {#description-4}

When `true`, strikes through the text in this element. Defaults to `false`.

#### underline? {#underline}

```
optional underline?: boolean;
```

##### Description {#description-5}

When `true`, underlines the text in this element. Defaults to `false`.

#### Description {#description-6}

A limited style object for styling rich text `text` elements.

#### Inherited from {#inherited-from}

[`RichTextStyleable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/richtextstyleable.md).[`style`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/richtextstyleable.md#style)

* * *

### type {#type}

```
type: "usergroup";
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:868

#### Description {#description-7}

The type of element. In this case `type` is always `usergroup`.

* * *

### usergroup_id {#usergroup_id}

```
usergroup_id: string;
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:872

#### Description {#description-8}

The encoded usergroup ID, e.g. S1234ABCD.