Skip to content

Commit 7e3141c

Browse files
wiggin77esethnaamyblais
authored
Add documentation for bulk set channel members API (#8876)
* Add documentation for bulk set channel members API Add setChannelMembers audit event to the audit log schema and document the new PUT /api/v4/channels/{channel_id}/members endpoint in the team and channel members admin guide. Introduced in Mattermost v11.7. * Added example * Removed examples, which are now in the API docs. * Update team-channel-members.rst * Apply suggestion from @wiggin77 --------- Co-authored-by: Eric Sethna <14333569+esethna@users.noreply.github.com> Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com>
1 parent ed2cfcc commit 7e3141c

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

source/administration-guide/comply/embedded-json-audit-log-schema.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,8 @@ Channel Management Events
256256
+------------------------------------+-------------------------------------------------------------------+
257257
| ``removeChannelMember`` | Removing members from channels |
258258
+------------------------------------+-------------------------------------------------------------------+
259+
| ``setChannelMembers`` | Bulk set (replace) channel memberships |
260+
+------------------------------------+-------------------------------------------------------------------+
259261
| ``restoreChannel`` | Restoring deleted channels |
260262
+------------------------------------+-------------------------------------------------------------------+
261263
| ``updateChannel`` | Updating channel information |

source/administration-guide/manage/team-channel-members.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,7 @@ A list of all members in a channel is visible to system admins. Members can be a
153153
- Member
154154
- Channel admin
155155
- System admin
156+
157+
.. note::
158+
159+
From Mattermost v11.5.2, system admins can set the complete membership of a channel in a single API call. The server computes the diff against the current membership and adds or removes users as needed. See the `API documentation <https://api.mattermost.com/#tag/channels/operation/SetChannelMembers>`__ for details.

0 commit comments

Comments
 (0)