Purpose

This API is used to delete a group from the organization. 

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to groups.

DELETE - Delete group.

Request URL

Method : DELETE

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

or

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

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 in which the data has to be updated.
    • This parameter can be retrieved from the All Groups Details API.

Request Body

  • groupList*  JSON Array of long
    • This parameter needs to be passed as an array of single or multiple zgid that need to be deleted
    • zgid is a unique identifier assigned to an email group.

 

* - 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" \
-X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
    "groupList": [
        18550138,
       18550139,
       18550137,
       18550134
    ]
}'

Sample Request Body

Copied{
    "groupList": [
        18550138,
       18550139,
       18550137,
       18550134
    ]
}

Sample Response

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