POST /admin.users.assign

Add an Enterprise user to a workspace.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

token String Yes

Authentication token. Requires scope: admin.users:write

Request body fields

Name Type Required Description
is_restricted Boolean No

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

team_id String Yes

The ID (T1234) of the workspace.

is_ultra_restricted Boolean No

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

channel_ids String No

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

user_id String Yes

The ID of the user to add to the workspace.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.