[NEW] REST endpoint to set groups' announcement (#11905)

packages/rocketchat-api/server/v1/groups.js

@@ -729,6 +729,24 @@ RocketChat.API.v1.addRoute('groups.setType', { authRequired: true }, {
 	},
 });
 
+RocketChat.API.v1.addRoute('groups.setAnnouncement', { authRequired: true }, {
+	post() {
+		if (!this.bodyParams.announcement || !this.bodyParams.announcement.trim()) {
+			return RocketChat.API.v1.failure('The bodyParam "announcement" is required');
+		}
+
+		const findResult = findPrivateGroupByIdOrName({ params: this.requestParams(), userId: this.userId });
+
+		Meteor.runAsUser(this.userId, () => {
+			Meteor.call('saveRoomSettings', findResult.rid, 'roomAnnouncement', this.bodyParams.announcement);
+		});
+
+		return RocketChat.API.v1.success({
+			announcement: this.bodyParams.announcement,
+		});
+	},
+});
+
 RocketChat.API.v1.addRoute('groups.unarchive', { authRequired: true }, {
 	post() {
 		const findResult = findPrivateGroupByIdOrName({ params: this.requestParams(), userId: this.userId, checkedArchived: false });

tests/end-to-end/api/03-groups.js

@@ -430,6 +430,22 @@ describe('[Groups]', function() {
 			.end(done);
 	});
 
+	it('/groups.setAnnouncement', (done) => {
+		request.post(api('groups.setAnnouncement'))
+			.set(credentials)
+			.send({
+				roomId: group._id,
+				announcement: 'this is an announcement of a group for api tests',
+			})
+			.expect('Content-Type', 'application/json')
+			.expect(200)
+			.expect((res) => {
+				expect(res.body).to.have.property('success', true);
+				expect(res.body).to.have.nested.property('announcement', 'this is an announcement of a group for api tests');
+			})
+			.end(done);
+	});
+
 	it('/groups.setType', (done) => {
 		request.post(api('groups.setType'))
 			.set(credentials)