This method renames a private channel.
Argument | Example | Required | Description |
---|---|---|---|
token | xxxx-xxxxxxxxx-xxxx |
Required | Authentication token bearing required scopes. |
channel | G1234567890 |
Required | Private channel to rename |
name | Required | New name for private channel. |
|
validate | true |
Optional | Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. |
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Private channel names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 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.
Returns a group object:
{
"ok": true,
"channel": {
"id": "G024BE91L",
"name": "secretplans",
"is_group": "true",
"created": 1360782804,
"creator": "U024BE7LH",
"is_archived": false,
"members": [
"U024BE7LH"
],
"topic": { … },
"purpose": { … },
"last_read": "1401383885.000061",
"latest": { … }
"unread_count": 0,
"unread_count_display": 0
},
}
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 |
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 |
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. |
missing_scope |
The token used is not granted the specific scope permissions required to complete this request. |
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. |
invalid_arguments |
The method was called with invalid arguments. |
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_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. |
request_timeout |
The method was called via a |
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. |
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 |