Sample - Slack Web API
POST/admin.users.assign

Assign a user to a workspace

Adds an Enterprise user to a workspace. Provide team_id and user_id, and optionally configure guest access with is_restricted, is_ultra_restricted, and channel_ids. Use a token with the admin.users:write scope to authorize the assignment.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 5 body fields
tokenstringrequired
Authentication token with the `admin.users:write` scope.

Workspace user assignment submitted as form data.

team_idstringrequired
The ID (`T1234`) of the workspace.
user_idstringrequired
The ID of the user to add to the workspace.
is_restrictedbooleanoptional
True if user should be added to the workspace as a guest.
is_ultra_restrictedbooleanoptional
True if user should be added to the workspace as a single-channel guest.
channel_idsstringoptional
Comma separated values of channel IDs to add user in the new workspace.

2 status codes
200Returns an object with `ok` set to true when the user is added to the workspace.
okbooleanrequired
Allowed:true
defaultReturns an object with `ok` set to false when the request cannot be completed.
okbooleanrequired
Allowed:false

Error handling

The request must include team_id and user_id. token must have the admin.users:write scope, and the guest flags and channel_ids determine the user's access level and channel membership.