mcp_config_group_member_handling.json•10.6 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e This API only supports \u003cb\u003euser-managed\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e.\u003c/p\u003e\u003cbr\u003e",
"name": "remove_a_user_level_channel_member"
},
{
"description": "A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.\u003cbr\u003e\u003cbr\u003e **Scopes:** `chat_channel:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \u003cbr\u003e \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003e For an\u003cb\u003e account-level\u003c/b\u003e \u003ca href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\"\u003eOAuth app\u003c/a\u003e, this API can only be used on behalf of a user who is assigned with a \u003cb\u003e\u003ca href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.\u0026text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"\u003e role\u003c/a\u003e that has Edit permission for Chat Channels\u003c/b\u003e.\u003c/p\u003e",
"name": "remove_a_channel_member"
},
{
"description": "Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "group"
},
{
"description": "Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "group_update"
},
{
"description": "List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "group_members"
},
{
"description": "Add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "group_members_create"
},
{
"description": "Delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account. **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "group_members_delete"
},
{
"description": "If a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group\u0027s 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.\u003cbr\u003e\u003cbr\u003e 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\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or higher account\u003cbr\u003e **Scopes:** `group:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_a_group_member"
},
{
"description": "Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). **Prerequisite**: Pro, Business, or Education account\u003cbr\u003e **Scopes**: `group:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "get_group_settings"
},
{
"description": "List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).\u003cbr\u003e\u003cbr\u003e **Scope:** `imgroup:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "im_group_members"
},
{
"description": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.\u003cbr\u003e\u003cbr\u003e **Scope:** `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "im_group_members_create"
},
{
"description": "Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.\u003cbr\u003e\u003cbr\u003e Scopes: `imgroup:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "im_group_members_delete"
},
{
"description": "Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "unassign_all_members"
},
{
"description": "Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. **Prerequisites:**\u003cbr\u003e * Pro or higher account plan. * Zoom Phone license\u003cbr\u003e **Scopes:** `phone:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "unassign_member_from_call_queue"
},
{
"description": "A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to list all the Shared Line Groups. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * Account owner or admin privileges \u003cbr\u003e **Scopes:** `phone:read:admin`, `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_shared_line_groups"
},
{
"description": "Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group\u0027s phone number and voicemail. Use this API to unassign **all** the existing members from a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_members_of_s_l_g"
},
{
"description": "A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group\u0027s direct phone number and voicemail. Use this API to [add members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a Shared Line Group. Note that a member can only be added to one shared line group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "add_members_to_shared_line_group"
},
{
"description": "Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group\u0027s phone number and voicemail. Use this API to unassign **a specific member** from a Shared Line Group. **Prerequisties:** \u003cbr\u003e * Pro or higher account with Zoom Phone license. * A valid Shared Line Group * Account owner or admin privileges **Scopes:** `phone:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_a_member_s_l_g"
}
]
}