Post
/api/v1/groups.setDescription
Set the description for the private channel. Permission required: edit-room
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
{
"roomId": "ByehQjC44FwMeiLbX",
"description": "Test out everything"
}object
roomId
string Required
The private group ID. You can find the IDs by using any of the following endpoints:
- Get List of User Groups: This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- Get Groups: This endpoint returns the private channels that you are a member of.
ExampleByehQjC44FwMeiLbX
description
string Required
Enter a description for the private channel.
ExampleTest description
Responses
200
OK
Success
{
"description": "Testing out everything.",
"success": true
}object
description
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The bodyParam \"description\" is required"
}Example 2
{
"success": false,
"error": "The parameter \"roomId\" or \"roomName\" is required [error-room-param-not-provided]",
"errorType": "error-room-param-not-provided"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string