Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.conversations.rename.json
Raw

priv/docs/methods/admin.conversations.rename.json

{
"args": {
"channel_id": {
"desc": "The channel to rename.",
"example": "C12345",
"required": true
},
"name": {
"desc": "",
"required": true,
"type": "string"
}
},
"desc": "Rename a public or private channel.",
"errors": {
"channel_not_found": "The value passed for `channel_id` was invalid.",
"channel_type_not_supported": "The provided `channel_id` was a DM, MPDM, or the 'general' channel.",
"could_not_rename_channel": "The channel could not be renamed.",
"default_org_wide_channel": "The default org-wide channel can't be renamed.",
"feature_not_enabled": "The token provided doesn't have access to this method.",
"invalid_name_maxlength": "The channel name exceeds the maximum allowed length.",
"name_taken": "The channel's name is already being used elsewhere.",
"restricted_action": "A workspace preference prevents the authenticated user from renaming a 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"
}
]
}
}