Set Channel Description

Sets the description for the channel.

Body Parameters

Example Call

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

Example Response

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

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.