admin.usergroups.addChannels

Add one or more default channels to an IDP group.

Facts

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

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

Helpful hint: some channels may not be set as defaults. The channel types that may not be set as default are private channels, externally-shared channels, and default org-wide channels (where everyone is a member anyway).

Another note: if a channel specified has already been linked to the given IDP group, no changes occur (for example, users that have chosen to leave the default channel will not be added again.)

Arguments

token

Authentication token bearing required scopes.

Examplexxxx-xxxxxxxxx-xxxx
channel_ids

Comma separated string of channel IDs.

ExampleC00000000,C00000001
usergroup_id

ID of the IDP group to add default channels for.

ExampleS00000000
team_id

The workspace to add default channels in.

ExampleT00000000

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

Response

Common successful response

Typical success response

{
    "ok": true
}
Common error response

Typical error response if the token provided is not associated with an Org Admin or Owner

{
    "ok": false,
    "error": "not_an_admin"
}

You may also receive a "partial" success response when some of the provided channels in the channel_ids are added successfully. In this case, invalid_channels contains the channels that could not be added.

{
    "ok": false,
    "error": "channel_not_found",
    "invalid_channels": ["C1234D1R4", "C1234D1R5"]
}

You might see a partial success response if you do not have enough permissions to manage all the specified channels, or if some channel_ids are not valid, or if the types of some channels are not supported.

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
not_an_admin

The token provided is not associated with an Org Admin or Owner.

not_an_enterprise

The token passed in does not belong to an Enterprise organization.

feature_not_enabled

The Admin APIs feature is not enabled for this workspace.

usergroup_not_found

The IDP group provided was not found.

usergroup_not_linked_to_team

The IDP group provided is not linked to the workspace.

usergroup_team_not_provisioned

The IDP group provided is linked to a workspace that has auto-provision disabled.

team_not_found

The workspace provided was not found.

channel_not_found

At least one of the provided channel IDs could not be found, or one of the channels has a type that is not supported.

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.

invalid_channels_limit

The number of channel IDs passed in is larger than 100.

not_authed

No authentication token provided.

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.

not_allowed_token_type

The token type used in this request is not allowed.

method_deprecated

The method has been deprecated.

deprecated_endpoint

The endpoint has been deprecated.

two_factor_setup_required

Two factor setup is required.

enterprise_is_restricted

The method cannot be called from an Enterprise.

is_bot

This method cannot be called by a bot user.

invalid_arguments

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

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_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.

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.

ratelimited

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

accesslimited

Access to this method is limited on the current network

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

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.

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.

Was this page helpful?