Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods conversations.setPurpose.json
Raw

priv/docs/methods/conversations.setPurpose.json

{
"args": {
"channel": {
"desc": "Channel to set the description of",
"required": true,
"type": "string"
},
"purpose": {
"desc": "The description",
"example": "This is the random channel, anything goes!",
"required": true,
"type": "string"
}
},
"desc": "Sets the channel description.",
"errors": {
"channel_not_found": "Value passed for `channel` was invalid.",
"is_archived": "Channel has been archived.",
"method_not_supported_for_channel_type": "This conversation type cannot be used with this method.",
"not_in_channel": "Authenticated user is not in the channel.",
"too_long": "Description was longer than 250 characters.",
"user_is_restricted": "Setting the channel description is a restricted action."
},
"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.topic",
"url": "https://docs.slack.dev/reference/scopes/channels.write.topic"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "groups:write.topic",
"url": "https://docs.slack.dev/reference/scopes/groups.write.topic"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "im:write.topic",
"url": "https://docs.slack.dev/reference/scopes/im.write.topic"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
},
{
"name": "mpim:write.topic",
"url": "https://docs.slack.dev/reference/scopes/mpim.write.topic"
}
],
"user": [
{
"name": "channels:write",
"url": "https://docs.slack.dev/reference/scopes/channels.write"
},
{
"name": "channels:write.topic",
"url": "https://docs.slack.dev/reference/scopes/channels.write.topic"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "groups:write.topic",
"url": "https://docs.slack.dev/reference/scopes/groups.write.topic"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "im:write.topic",
"url": "https://docs.slack.dev/reference/scopes/im.write.topic"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
},
{
"name": "mpim:write.topic",
"url": "https://docs.slack.dev/reference/scopes/mpim.write.topic"
}
]
}
}