PATCH /groups/{groupId}/members/{memberId}
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
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
memberId |
String | Yes |
Unique Identifier of the group member. Can be retrieved by calling the List Group Members API. |
groupId |
String | Yes |
Unique Identifier of the group. Can be retrieved by calling GET /groups API. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
target_group_id |
String | No |
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. |
action |
String | Yes |
Specify the type of action to be performed: Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.