admin.conversations.setTeams

Set the workspaces in an Enterprise grid org that connect to a channel.

Facts

Method URL:https://slack.com/api/admin.conversations.setTeams
Preferred HTTP method:POST
Accepted content types:application/x-www-form-urlencoded, application/json
Rate limiting:Tier 2
Works with:
Token typeRequired scope(s)
useradmin.conversations:write 

This Admin API method sets the workspaces connected to a channel.

When used with the team_id parameter, this method sets the requested channel_id as a regular channel on the team_id workspace.

When used with the target_team_ids parameter, this method sets the requested channel_id as a cross-workspace shared channel. The channel is shared to all the workspaces in target_team_ids.

Either way, this method can be used both to add and to remove workspaces from a channel.

This API method for admins may only be used on Enterprise Grid.

Arguments

Argument Example Required Description
tokenxxxx-xxxxxxxxx-xxxxRequired

Authentication token bearing required scopes.

channel_id Required

The encoded channel_id to add or remove to workspaces.

org_channeltrueOptional, default=false

True if channel has to be converted to an org channel

target_team_ids Optional

The list of workspaces to which the channel should be shared. Not required if the channel is being shared orgwide.

team_id Optional

The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

This admin scope is obtained through the OAuth flow, but there are a few additional requirements. The app requesting this scope must be installed by an admin or Owner of an Enterprise Grid organization. Also, the app must be installed on the entire org, not on an individual workspace. See below for more details.

Admin API endpoints reach across an entire Enterprise Grid organization, not individual workspaces.

For a token to be imbued with Admin scopes, it must be obtained from installing an app on the entire Grid org, not just a workspace within the organization.

To configure and install an app supporting Admin API endpoints on your Enterprise Grid organization:

  1. Create a new Slack app. Your app will need to be able to handle a standard OAuth 2 flow.
  2. In the app's settings, select OAuth & Permissions from the left navigation. Scroll down to the section titled Scopes and add the admin.* scope you want. Click the green Save Changes button.
  3. In the app's settings, select Manage Distribution from the left navigation. Under the section titled Share Your App with Other Workspaces, make sure all four sections have the green check. Then click the green Activate Public Distribution button.
  4. Under the Share Your App with Your Workspace section, copy the Sharable URL and paste it into a browser to initiate the OAuth handshake that will install the app on your organization. You must be logged in as an admin or Owner of your Enterprise Grid organization to install the app.
  5. Check the dropdown in the upper right of the installation screen to make sure you are installing the app on the organization, not an individual workspace within the organization. See the image below for a visual.
  6. Once your app completes the OAuth flow, you will be granted an OAuth token that can be used for calling Admin API methods for your organization.

When installing an app to use an Admin API endpoint, be sure to install it on your Grid organization, not a workspace within the organization.

Response

Typical success response

{
    "ok": true
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

ErrorDescription
restricted_action

The caller of this API is not allowed to perform this operation.

not_enabled

The API endpoint is not enabled for your team.

invalid_channel_id

channel_id was invalid.

channel_not_found

The channel wasn't found or isn't shared to this workspace.

invalid_target_team

Target workspace is invalid.

channel_type_not_supported

The requested channel_id is not a supported type of channel.

channel_not_shared_with_team

The requested channel_id has not been shared with the target workspace.

channel_cannot_be_unshared

Channel cannot be unshared from this workspace.

default_org_wide_channel

Default org wide channel cannot be unshared from a workspace.

unsupported_arguments

The provided method arguments are not supported.

too_many_target_teams

Too many target_team_ids were provided.

not_authed

No authentication token provided.

invalid_auth

Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

account_inactive

Authentication token is for a deleted user or workspace.

token_revoked

Authentication token is for a deleted user or workspace or the app has been removed.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ekm_access_denied

Administrators have suspended the ability to post a message.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

is_bot

This method cannot be called by a bot user.

invalid_arguments

The method was called with invalid arguments.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

fatal_error

The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

WarningDescription
missing_charset

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

superfluous_charset

The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.