Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

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

priv/docs/methods/groups.setPurpose.json

{
"args": {
"channel": {
"desc": "Private channel to set the purpose of",
"required": true,
"type": "channel"
},
"purpose": {
"desc": "The new purpose",
"example": "My Purpose",
"required": true
}
},
"desc": "Sets the purpose for a private channel.",
"errors": {
"channel_not_found": "Value passed for `channel` was invalid.",
"is_archived": "Private group has been archived",
"too_long": "Purpose was longer than 250 characters.",
"user_is_restricted": "Setting the purpose is a restricted action."
}
}