Links
Comment on page

Group Set Topic

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

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The private group's id
topic
Discuss all of the testing.
Required
The private group's topic to set.

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.setTopic \
-d '{ "roomId": "ByehQjC44FwMeiLbX", "topic": "Discuss all of the testing" }'

Example Result

{
"topic": "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.