Update a Group Member

If a user is a member in multiple groups, you can set a primary group https://support.zoom.us/hc/enus/articles/204519819GroupManagement#h_d07c7dcd4fd8485ab5fea322e8d21c09 for the user. The group member will use the primary group's settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.Use this API to perform either of the following tasks:* Simultaneously remove a member from one group and move the member to a different group.* Set a primary group for the user**Prerequisites:** * Pro or higher account **Scopes:** group:write:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium

updateGroupMember(
  groupId,
  memberId,
  action,
  target_group_id = NULL,
  return_response = F
)

Arguments

groupId	Unique Identifier of the group. Can be retrieved by calling GET /groups https://marketplace.zoom.us/docs/apireference/zoomapi/groups/groups API. To change a member's primary group, provide the groupId of the member's current primary group as the value of this field. To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.
memberId	Unique Identifier of the group member. Can be retrieved by calling the List Group Members https://marketplace.zoom.us/docs/apireference/zoomapi/groups/groupmembers API.
action	Specify the type of action to be performed:move: Simultaneously remove a member from one group and move the member to a different group.set_primary: Set a primary group for the user.
target_group_id	Can be retrieved by calling GET /groups https://marketplace.zoom.us/docs/apireference/zoomapi/groups/groups API.To move a user, use this field to specify the groupId of the group where the member is to be moved.To set a primary group for the user, provide the groupId of the group which is going to be the primary group.
return_response	Whether to return the response instead of the response content. Defaults to FALSE.

Arguments

Contents