admin.conversations.setTeams

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

Notices

This API method can only be used on Enterprise Grid workspaces.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/admin.conversations.setTeams
Bolt for Java
app.client().adminConversationsSetTeams
Powered by Bolt
Bolt for Python
app.client.admin_conversations_setTeams
Powered by Bolt
Bolt for JavaScript
app.client.admin.conversations.setTeams
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 2
  • Arguments

    Required arguments

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Example
    xxxx-xxxxxxxxx-xxxx

    The encoded channel_id to add or remove to workspaces.

    Optional arguments

    True if channel has to be converted to an org channel

    Default
    false
    Example
    true

    A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.

    Example
    T1234,T5678,T9012,T3456

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

    Usage info

    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, including the workspace that originated the channel.

    When connecting a workspace to many channels at the same time, the message history for each channel will be available after all channels have been processed. To access a channel's message history before the process is complete, a hard refresh is required. Additionally, for particularly larger requests, the process may take some time.

    This admin scope is obtained through version two of the OAuth V2 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.

    If the app is installed by an Org Admin or Owner, ensure the Channel Management settings provide the appropriate permissions. In order to manage channels after they are created, you must update your token to enable permissions for Org Admins or Owners (not just the Primary Org Owner).

    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.

    Example responses

    Common successful 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
    cannot_add_legacy_disconnected_channel_to_workspaces

    Cannot add legacy disconnected channel to workspaces

    cannot_move_local_channel

    This API cannot be used to move a local channel from one workspace to another.

    channel_cannot_be_unshared

    Channel cannot be unshared from this workspace.

    channel_not_found

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

    channel_type_not_supported

    The requested channel_id is not a supported type of channel.

    could_not_set_teams_for_channel

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

    default_org_wide_channel

    Default org wide channel cannot be unshared from a workspace.

    externally_shared_or_disconnected_channel

    The channel is or was externally shared.

    invalid_channel_id

    channel_id was invalid.

    invalid_target_team

    Target workspace is invalid.

    managed_channel_not_supported

    Cannot unshare a managed channel

    name_taken

    The proposed new name for the channel is already in use within your organization.

    not_allowed_for_grid_workspace

    Slack Connect is not allowed for this grid workspace

    not_enabled

    The API endpoint is not enabled for your team.

    restricted_action

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

    too_many_target_teams

    Too many target_team_ids were provided.

    unsupported_arguments

    The provided method arguments are not supported.

    access_denied

    Access to a resource specified in the request is denied.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    deprecated_endpoint

    The endpoint has been deprecated.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    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.

    is_bot

    This method cannot be called by a legacy bot.

    method_deprecated

    The method has been deprecated.

    missing_scope

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

    not_allowed_token_type

    The token type used in this request is not allowed.

    not_authed

    No authentication token provided.

    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.

    token_expired

    Authentication token has expired

    token_revoked

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

    two_factor_setup_required

    Two factor setup is required.

    accesslimited

    Access to this method is limited on the current network

    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.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    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_arguments

    The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    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.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    request_timeout

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

    service_unavailable

    The service is temporarily unavailable

    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.

    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.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response