Update an IM directory group

PATCH

/im/groups/{groupId}

Update an IM directory group under your account.

Scopes: imgroup:write:admin

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://api.zoom.us/v2/im/groups/'

响应示例

204 - 示例 1

{}

请求参数

Path 参数

groupId

string

必需

The group ID.

Can be retrieved by calling GET /groups.

Body 参数multipart/form-data

name

string

可选

Group name: must be unique to one account.

<= 128 字符

search_by_account

boolean

可选

Members can search for others under same account.

search_by_domain

boolean

可选

Members can search for others in the same email domain.

search_by_ma_account

boolean

可选

Members can search for others under same master account, including all sub accounts.

type

enum<string>

可选

IM Group types:
normal - Only group members can automatically see others in their group. Other people can search for members in the group.
shared - Everyone under the account can see the group and members automatically.
restricted - Nobody can see the group or search for members except for the members in the group.

枚举值:

normalsharedrestricted

返回响应

🟢204**HTTP Status Code:** `204` <br> IM group updated.

application/json

Body

object {0}

🔵300**Error Code:** `300` <br> Missing field: name

🟠404**HTTP Status Code:** `404` <br> IM Group not found. **Error Code:** `4130`<br> Group does not exist:{groupId}.

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

Retrieve an IM directory group

List IM directory group members