Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs admin.conversations.setTeams.json
Raw

lib/slack/web/docs/admin.conversations.setTeams.json

{
"args": {
"channel_id": {
"desc": "The encoded `channel_id` to add or remove to workspaces. 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.",
"required": true,
"type": "string"
},
"org_channel": {
"default": "false",
"desc": "True if channel has to be converted to an org channel",
"example": "true",
"required": false,
"type": "boolean"
},
"target_team_ids": {
"desc": "A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide. When used with the `target_team_ids` parameter, this method sets the requested `channel_id` as a cross-workspace shared channel.",
"example": "T1234,T5678,T9012,T3456",
"required": false,
"type": "array"
},
"team_id": {
"desc": "The workspace to which the channel belongs if the channel is a local workspace channel. Omit this argument if the channel is a cross-workspace or org-wide shared channel. When used with the `team_id` parameter, this method sets the requested `channel_id` as a regular channel on the `team_id` workspace.",
"required": false
}
},
"desc": "Set the workspaces in an Enterprise org that connect to a public or private channel.",
"errors": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"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.",
"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.",
"externally_shared_or_disconnected_channel": "The channel is or was externally shared.",
"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 called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"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_channel_id": "`channel_id` was invalid.",
"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`.",
"invalid_target_team": "Target workspace is invalid.",
"managed_channel_not_supported": "Cannot unshare a managed channel",
"method_deprecated": "The method has been deprecated.",
"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.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"name_taken": "The proposed new name for the channel is already in use within your organization.",
"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.",
"not_allowed_for_grid_workspace": "Slack Connect is not allowed for this Enterprise org workspace",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"not_enabled": "The API endpoint is not enabled for your team.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"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.",
"restricted_action": "The caller of this API is not allowed to perform this operation.",
"service_unavailable": "The service is temporarily unavailable",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"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.",
"too_many_target_teams": "Too many `target_team_ids` were provided.",
"two_factor_setup_required": "Two factor setup is required.",
"unsupported_arguments": "The provided method arguments are not supported."
}
}