provider admin.usersadmin POST /admin.users.invite
@utdk/slack /admin.users.invite
admin_users_invite
Invite a user to a workspace.
token header required
Authentication token. Requires scope: `admin.users:write`
string

Try it

Authentication
Configure credentials for Slack Web API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

adminUsersInvite
POST/admin.users.invite
Invite a user to a workspace.

Input

required

A comma-separated list of `channel_id`s for this user to join. At least one channel is required.

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

required

The email address of the person to invite.

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 this user a multi-channel guest user? (default: false)

Is this user a single channel guest user? (default: false)

Full name of the user.

Allow this invite to be resent in the future if a user has not signed up yet. (default: false)

required

The ID (`T1234`) of the workspace.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import slack from '@utdk/slack';

await slack.adminUsersInvite()