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.)
This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.
Typical success response
Typical error response if the token provided is not associated with an Org Admin or Owner
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.
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.
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.
The token provided is not associated with an Org Admin or Owner.
The token passed in does not belong to an Enterprise organization.
The Admin APIs feature is not enabled for this workspace.
The IDP group provided was not found.
The IDP group provided is not linked to the workspace.
The IDP group provided is linked to a workspace that has auto-provision disabled.
The workspace provided was 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.
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.
The number of channel IDs passed in is larger than 100.
No authentication token provided.
Authentication token is for a deleted user or workspace.
Authentication token is for a deleted user or workspace or the app has been removed.
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.
The workspace is undergoing an enterprise migration and will not be available until migration is complete.
Administrators have suspended the ability to post a message.
The token used is not granted the specific scope permissions required to complete this request.
This method cannot be called by a bot user.
The method was called with invalid arguments.
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.
The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.
The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.
The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
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.
The method was called via a POST request, but the POST data was either missing or truncated.
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.
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.
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.
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.
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.