Update group description API in Zoho WorkDrive

Update Group Description

This API helps in changing the description of a group.

Note:
Only the team member, who created the group, can update the description of the group.

Endpoints

patch https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}

Copy full URL

OAuth Scope

WorkDrive.groups.UPDATECopied!

curl --request PATCH \
  --url https://www.zohoapis.com/workdrive/api/v1/groups/{group_id} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"description":"Engineering managers group"},"type":"groups"}}'

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("description","Engineering managers group");
data_param1.put("attributes",att_param1);
data_param1.put("type","groups");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/groups/{group_id}"
type : PATCH
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

group_idstring(Required)

The unique ID of the group

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

descriptionstring(Required)

A brief description of the group.

typestring(Required)

The JSON:API resource type. Always "groups".

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "description": "Engineering managers group"
      },
      "type": "groups"
    }
  }

▼ Show full

  {
    "data": {
      "id": "ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021",
      "type": "groups",
      "attributes": {
        "owner": "747937818",
        "created_time": "Apr 13, 12:15 AM",
        "capabilities": {
          "can_read": true,
          "can_delete": true,
          "can_edit": true,
          "can_trash": true,
          "can_rename": true,
          "can_restore": true,
          "can_add_members": true
        },
        "description": "Engineering managers group",
        "type": 1,
        "created_by": "Zylker Creation",
        "modified_time": "Apr 13, 12:24 AM",
        "avatar_url": "https://js.zohostatic.com/personal/stable/jsapps/ui-lab/dist/assets/dev/svg-icons/common/groups_logo-1b99e1d06fa5e3bb404e335e6ce2f43a.svg",
        "parent_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
        "name": "Managers - Engg",
        "modified_by": "Zylker Creation",
        "members_count": 1,
        "status": 1
      },
      "relationships": {
        "groupmembers": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/relationships/groupmembers",
            "related": "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021/groupmembers"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/groups/ly9zmae16b43c258f458a9a57ac02c4f8d763-2774428000000002021"
      }
    }
  }

  {
    "errors": [
      {
        "id": "R002",
        "title": "Folder with same name exists in the workspace. Please use a different name"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "F000",
        "title": "General exception"
      }
    ]
  }

▼ Show full