Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.usergroups.addChannels.json
Raw

priv/docs/methods/admin.usergroups.addChannels.json

{
"args": {
"channel_ids": {
"desc": "Comma separated string of channel IDs.",
"example": "C00000000,C00000001",
"required": true,
"type": "array"
},
"team_id": {
"desc": "The workspace to add default channels in.",
"example": "T00000000",
"required": false,
"type": "string"
},
"usergroup_id": {
"desc": "ID of the IDP group to add default channels for.",
"example": "S00000000",
"required": true,
"type": "string"
}
},
"desc": "Add up to one hundred default channels to an IDP group.",
"errors": {
"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.",
"feature_not_enabled": "The Admin APIs feature is not enabled for this workspace.",
"invalid_channels_limit": "The number of channel IDs passed in is larger than 100.",
"not_an_admin": "The calling user cannot update the specified usergroup.",
"not_an_enterprise": "The token passed in does not belong to an Enterprise organization.",
"team_not_found": "The workspace provided was not found.",
"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."
},
"rate_limit": {
"label": "Tier 1: 1+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.usergroups:write",
"url": "https://docs.slack.dev/reference/scopes/admin.usergroups.write"
}
]
}
}