Current section
Files
Jump to
Current section
Files
priv/docs/methods/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": {
"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 Enterprise org 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."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.conversations:write",
"url": "https://docs.slack.dev/reference/scopes/admin.conversations.write"
}
]
}
}