Set Group Purpose
- Print
- DarkLight
- PDF
Set Group Purpose
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/groups.setPurpose
Sets the description for the group/channel (the same as groups.setDescription, obsolete).
Changelog
| Version | Description |
|---|---|
| 0.48.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"roomId": "ByehQjC44FwMeiLbX",
"purpose": "Test out everything"
}object
roomId
string Required
The group id
purpose
string Required
The group purpose
Responses
200
OK
Example 1
{
"purpose": "Testing out everything.",
"success": true
}object
purpose
string
success
boolean
Was this article helpful?