Post
/api/v1/groups.setAnnouncement
Set the private channel announcement.
Permission required: edit-room
Changelog
Version | Description |
---|---|
0.70.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken
of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId
of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"roomId": "ByehQjC44FwMeiLbX",
"announcement": "Test out everything"
}
object
roomId
string Required
The private group ID. You can find the IDs by using any of the following endpoints:
- Get List of User Groups: This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- Get Groups: This endpoint returns the private channels that you are a member of.
announcement
string Required
The announcement to set for the private group.
Responses
200
OK
Success
{
"announcement": "Test out everything.",
"success": true
}
object
announcement
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string