Update a group member

PATCH

/groups/{groupId}/members/{memberId}

Groups

If a user is a member in multiple groups, you can set a primary group 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: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://api.zoom.us/v2/groups//members/' \
--form 'action=""'

响应示例

204 - 示例 1

null

请求参数

Path 参数

groupId

string

必需

Unique Identifier of the group. Can be retrieved by calling GET /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

string

必需

Unique Identifier of the group member. Can be retrieved by calling the List Group Members API.

Body 参数multipart/form-data

action

enum<string>

必需

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.

枚举值:

moveset_primary

target_group_id

string

可选

Can be retrieved by calling GET /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.

返回响应

🟢204**HTTP Status Code:** `204` **No Content** Group member updated.

application/json

Body

No schema defined

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` Only available for Paid account, {accountId}. **Error Code:** `300` The target_group_id can not be empty. **Error Code:** `1010` Group does not belong t

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `4130` A group with this {groupId} does not exist.

修改于 2024-04-24 09:06:48

Delete a group member

Get a group's settings