Delete Group Members

Purpose

This API is used to delete existing members from a group.

OAuth Scope

Use the scope

ZohoMail.organization.groups.ALL (or) ZohoMail.organization.groups.UPDATE

to generate the Authtoken.

ALL - Full access to groups.

UPDATE - Delete individual members from a group.

Request URL

Method : PUT

https://mail.zoho.com/api/organization/{zoid}/groups/{zgid}

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Organization Details API.
  • zgid* long
    • This parameter is used to identify the group from which individual members are to be deleted.
    • This parameter can be retrieved from the All Groups Details API.

Request Body (JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as deleteMailGroupMember.
  • mailGroupMemberList* JSON array of JSON object

    This contains the details of the group members to be deleted. The following parameters should be included in the object:

    • memberEmailId* string
      • memberEmailId represents the email address of the group member to be deleted.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/99***293/groups/25606***" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
    "mode": "deleteMailGroupMember",
    "mailGroupMemberList": [
        {
            "memberEmailId": "rebecca@zylker.com"
        }
    ]
}'

Sample Request Body

Copied{
    "mode": "deleteMailGroupMember",
    "mailGroupMemberList": [
        {
            "memberEmailId": "rebecca@zylker.com"
        }
    ]
}

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  }
}