conversations.rename
Renames a conversation.
Facts
Method URL: | https://slack.com/api/conversations.rename | ||||||
---|---|---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||||
Rate limiting: | Tier 2 | ||||||
Works with: |
|
channels:
, groups:
, im:
or mpim:
scopes corresponding to the conversation type you're working with.
This method renames a conversation. Some types of conversations cannot be renamed.
The only the user that originally created a channel or an admin may rename it. Others will receive a not_authorized
error.
Limits for workspace apps
Because workspace apps can't act on behalf of users, they don't have the power to rename conversations, except when they're the owner/creator of the conversation.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
channel
ID of conversation to rename
ExampleC1234567890
name
New name for conversation.
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Naming
Conversation names can only contain lowercase letters, numbers, hyphens, periods, and underscores, and must be 80 characters or less. We will validate the submitted channel name and modify it to meet the above criteria. When calling this method, we recommend storing the channel's name
value that is returned in the response.
Response
Returns a channel object.
Common successful response
Typical success response
{
"ok": true,
"channel": {
"id": "C012AB3CD",
"name": "general",
"is_channel": true,
"is_group": false,
"is_im": false,
"created": 1449252889,
"creator": "W012A3BCD",
"is_archived": false,
"is_general": true,
"unlinked": 0,
"name_normalized": "general",
"is_read_only": false,
"is_shared": false,
"is_ext_shared": false,
"is_org_shared": false,
"pending_shared": [],
"is_pending_ext_shared": false,
"is_member": true,
"is_private": false,
"is_mpim": false,
"last_read": "1502126650.228446",
"topic": {
"value": "For public discussion of generalities",
"creator": "W012A3BCD",
"last_set": 1449709364
},
"purpose": {
"value": "This part of the workspace is for fun. Make fun here.",
"creator": "W012A3BCD",
"last_set": 1449709364
},
"previous_names": [
"specifics",
"abstractions",
"etc"
],
"num_members": 23,
"locale": "en-US"
}
}
Common error response
Typical error response when the calling user is not a member of the conversation
{
"ok": false,
"error": "not_in_channel"
}
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
channel_not_found | Value passed for |
not_in_channel | Caller is not a member of the channel. |
not_authorized | Caller cannot rename this channel |
invalid_name | Value passed for |
name_taken | New channel name is taken |
invalid_name_required | Value passed for |
invalid_name_punctuation | Value passed for |
invalid_name_maxlength | Value passed for |
invalid_name_specials | Value passed for |
method_not_supported_for_channel_type | This type of conversation cannot be used with this method. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_authed | No authentication token provided. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
account_inactive | Authentication token is for a deleted user or workspace. |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
is_bot | This method cannot be called by a bot user. |
user_is_restricted | This method cannot be called by a restricted user or single channel guest. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
Warnings
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |