Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.rename.json
{
"args": {
"channel": {
"desc": "ID of conversation to rename",
"required": true,
"type": "string"
},
"name": {
"desc": "New name for conversation.",
"required": true,
"type": "string"
}
},
"desc": "Renames a conversation.",
"errors": {
"channel_not_found": "Value passed for `channel` was invalid.",
"invalid_name": "Value passed for `name` was invalid.",
"invalid_name_maxlength": "Value passed for `name` exceeded max length.",
"invalid_name_punctuation": "Value passed for `name` contained only punctuation.",
"invalid_name_required": "Value passed for `name` was empty.",
"invalid_name_specials": "Value passed for `name` contained unallowed special characters or upper case characters.",
"is_archived": "Cannot rename archived channel.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
"name_taken": "New channel name is taken.",
"not_authorized": "Caller cannot rename this channel.",
"not_in_channel": "Caller is not a member of the channel."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "channels:manage",
"url": "https://docs.slack.dev/reference/scopes/channels.manage"
},
{
"name": "channels:write",
"url": "https://docs.slack.dev/reference/scopes/channels.write"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
],
"user": [
{
"name": "channels:write",
"url": "https://docs.slack.dev/reference/scopes/channels.write"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
]
}
}