Reference
Fuselage
Channel Set Purpose
Sets the description for the channel (the same as channels.setDescription, obsolete).
URL
Requires Auth
HTTP Method
/api/v1/channels.setPurpose
yes
POST

Payload

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

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
-H "Content-type: application/json" \
4
http://localhost:3000/api/v1/channels.setPurpose \
5
-d '{ "roomId": "ByehQjC44FwMeiLbX", "purpose": "Test out everything" }'
Copied!

Example Result

1
{
2
"purpose": "Testing out everything.",
3
"success": true
4
}
Copied!

Change Log

Version
Description
0.48.0
Added
Last modified 8mo ago
Export as PDF
Copy link
Edit on GitHub