Slack Web API

/admin.users.assign

POST

/admin.users.assign

admin.usersadmin

Add an Enterprise user to a workspace.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/admin.users.assign' \
--header 'token;' \
--data-urlencode 'team_id=' \
--data-urlencode 'user_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

optional

Comma separated values of channel IDs to add user in the new workspace.

is_restricted

string

optional

True if user should be added to the workspace as a guest.

is_ultra_restricted

string

optional

True if user should be added to the workspace as a single-channel guest.

team_id

string

required

The ID (T1234) of the workspace.

user_id

string

required

The ID of the user to add to 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.usergroups.removeChannels

/admin.users.invite