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

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

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

# Interface: AdminUsersInviteArguments

Defined in: [packages/web-api/src/types/request/admin/users.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L73)

## Extends {#extends}

*   `ChannelIDs`.`TeamID`.`IsRestricted`.`IsUltraRestricted`.`TokenOverridable`

## Properties {#properties}

### channel_ids {#channel_ids}

```
channel_ids: [string, ...string[]];
```

Defined in: [packages/web-api/src/types/request/common.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L81)

#### Description {#description}

An array of channel IDs (must include at least one ID).

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

```
ChannelIDs.channel_ids
```

* * *

### custom_message? {#custom_message}

```
optional custom_message?: string;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L82)

#### Description {#description-1}

An optional message to send to the user in the invite email.

* * *

### email {#email}

```
email: string;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L80)

#### Description {#description-2}

The email address of the person to invite.

* * *

### email_password_policy_enabled? {#email_password_policy_enabled}

```
optional email_password_policy_enabled?: boolean;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L87)

#### Description {#description-3}

Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.

* * *

### guest_expiration_ts? {#guest_expiration_ts}

```
optional guest_expiration_ts?: string;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L92)

#### Description {#description-4}

Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.

* * *

### is_restricted? {#is_restricted}

```
optional is_restricted?: boolean;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L15)

#### Description {#description-5}

Set to `true` if user should be added to the workspace as a guest.

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

```
IsRestricted.is_restricted
```

* * *

### is_ultra_restricted? {#is_ultra_restricted}

```
optional is_ultra_restricted?: boolean;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L20)

#### Description {#description-6}

Set to `true` if user should be added to the workspace as a guest.

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

```
IsUltraRestricted.is_ultra_restricted
```

* * *

### real_name? {#real_name}

```
optional real_name?: string;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L94)

#### Description {#description-7}

Full name of the user.

* * *

### resend? {#resend}

```
optional resend?: boolean;
```

Defined in: [packages/web-api/src/types/request/admin/users.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L99)

#### Description {#description-8}

Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. Defaults to `false`.

* * *

### team_id {#team_id}

```
team_id: string;
```

Defined in: [packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61)

#### Description {#description-9}

The encoded team ID.

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

```
TeamID.team_id
```

* * *

### token? {#token}

```
optional token?: string;
```

Defined in: [packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43)

#### Description {#description-10}

Overridable authentication token bearing required scopes.

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

```
TokenOverridable.token
```