Reference
Fuselage
Channel Set Announcement
Sets the announcement for the channel.
URL
Requires Auth
HTTP Method
/api/v1/channels.setAnnouncement
yes
POST

Payload

Argument
Example
Required
Announcement
roomId
ByehQjC44FwMeiLbX
Required
The channel's id
announcement
Test out everything.
Required
The announcement 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.setAnnouncement \
5
-d '{ "roomId": "ByehQjC44FwMeiLbX", "announcement": "Test out everything" }'
Copied!

Example Result

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

Change Log

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