Links

Group Set Description

Sets the description for the private group.
URL
Requires Auth
HTTP Method
/api/v1/groups.setDescription
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The private group's id
description
Test out everything.
Required
The description to set for the private group.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
http://localhost:3000/api/v1/groups.setDescription \
-d '{ "roomId": "ByehQjC44FwMeiLbX", "description": "Test out everything" }'

Example Result

{
"description": "Testing out everything.",
"success": true
}

Change Log

Version
Description
0.48.0
Added
Last modified 1yr ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.