set-channel-description.md

Set Channel Description

Sets the description for the channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/channels.setDescription	yes

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID.
description*	Test out everything.	The description to set for the channel.

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

Version	Description
0.48.0	Added