set-group-announcement.md

Set Group Announcement

Sets the announcement for the group/channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/groups.setAnnouncement	yes

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The group ID.
announcement*	Test out everything	The announcement to set for the group.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/groups.setAnnouncement \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX", 
          "announcement": "Test out everything" }'

Example Response

{
  "announcement": "Test out everything",
  "success": true
}

Change Log

Version	Description
0.70.0	Added