Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.teams.settings.setDiscoverability.json
Raw

priv/docs/methods/admin.teams.settings.setDiscoverability.json

{
"args": {
"discoverability": {
"desc": "This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.",
"required": true,
"type": "string"
},
"team_id": {
"desc": "The ID of the workspace to set discoverability on.",
"required": true
}
},
"desc": "An API method that allows admins to set the discoverability of a given workspace",
"errors": {
"discoverability_setting_invalid": "The discovery setting must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.",
"failed_to_set_discoverability": "There was an error setting the discoverability of this workspace.",
"feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
"team_not_found": "The `team_id` was not found."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.teams:write",
"url": "https://docs.slack.dev/reference/scopes/admin.teams.write"
}
]
}
}