Update Group Name

Purpose

This API is used to change the name of a specific 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 - Change the group name.

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 the data has to be retrieved. This is generated during group addition.
    • This parameter can be retrieved from the Get all groups API.

Request Body ( JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as updateGroupName.
  • name* long
    • Provide the new name for the 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/25606***" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
    "mode": "updateGroupName",
    "name": "test"
}'

Sample Request Body

Copied{
    "mode": "updateGroupName",
    "name": "test"
}

Sample Response

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