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 |
Argument | Example | Required | Description |
---|---|---|---|
roomId | ByehQjC44FwMeiLbX | Required | The channel's id |
purpose | Test out everything. | Required | The description to set for the channel. |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
https://localhost:3000/api/v1/channels.setPurpose \
-d '{ "roomId": "ByehQjC44FwMeiLbX", "purpose": "Test out everything" }'
{
"purpose": "Testing out everything.",
"success": true
}
Version | Description |
---|---|
0.48.0 | Added |
Last modified 6mo ago