Slack Web API

/admin.users.invite

POST

/admin.users.invite

admin.usersadmin

Invite a user to a workspace.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/admin.users.invite' \
--header 'token;' \
--data-urlencode 'channel_ids=' \
--data-urlencode 'email=' \
--data-urlencode 'team_id='

Response Example

200 - response

{
  "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: admin.users:write

Body Params application/x-www-form-urlencoded

channel_ids

string

required

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

custom_message

string

optional

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

string

required

The email address of the person to invite.

guest_expiration_ts

string

optional

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

string

optional

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

is_ultra_restricted

string

optional

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

real_name

string

optional

Full name of the user.

resend

string

optional

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

team_id

string

required

The ID (T1234) of the workspace.

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

Modified at 2023-08-15 05:39:45

/admin.users.assign

/admin.users.list