Reference
API
Fuselage
Channel Set Description
Sets the description for the channel.
URL
Requires Auth
HTTP Method
/api/v1/channels.setDescription
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel's id
description
Test out everything.
Required
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" \
http://localhost:3000/api/v1/channels.setDescription \
-d '{ "roomId": "ByehQjC44FwMeiLbX", "description": "Test out everything" }'

Example Result

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

Change Log

Version
Description
0.48.0
Added
Export as PDF
Copy link
Edit on GitHub
On this page
Payload
Example Call
Example Result
Change Log