Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.conversations.archive.json
{
"args": {
"channel_id": {
"desc": "The channel to archive.",
"example": "C12345",
"required": true
}
},
"desc": "Archive a public or private channel.",
"errors": {
"already_archived": "This channel has already been archived.",
"cant_archive_general": "You cannot archive the 'general' channel.",
"channel_not_found": "The value passed for `channel` was invalid.",
"channel_type_not_supported": "The value passed for `channel` was an MPDM, DM, or the 'general' channel.",
"could_not_archive_channel": "The provided channel could not be archived.",
"default_org_wide_channel": "The default org-wide channel cannot be archived.",
"feature_not_enabled": "The token provided does not have access to this method.",
"restricted_action": "A workspace preference prevents the authenticated user from archiving this channel."
},
"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"
}
]
}
}