Edit a Collection

Purpose

This API is used to edit the details of a specific collection.

OAuth Scope

Use the scope

ZohoMail.links.ALL (or) ZohoMail.links.UPDATE

to generate the Authtoken.

ALL - Grants full access to links.

UPDATE - Grants update access to links.

Request URL

Method: PUT

For Group :

https://mail.zoho.com/api/links/groups/{groupId}/collections/{collectionId}

For Personal :

https://mail.zoho.com/api/links/me/collections/{collectionId}

Path Parameters

groupId* long
- Specifies the unique ID of the group.
- This parameter can be retrieved from the Get all groups in the Bookmarks API.
collectionId* long
- Specifies the unique ID of the collection.
- This parameter can be retrieved from the Get all collections API.

Request Body ( JSON Object)

collectionName* string
- Provide the updated name for the collection.

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group

Copiedcurl "https://mail.zoho.com/api/links/groups/123456789/collections/3764869000000013001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "collectionName": "zylker"
 }'

Sample Request - For Personal

Copiedcurl "https://mail.zoho.com/api/links/me/collections/3764869000000013001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "collectionName": "zylker"
 }'

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "collectionId": "3764869000000013001",
    "collectionName": "zylker"
  }
}

Sample Failure Response

Copied{
  "data": {
    "errorCode": "PATTERN_NOT_MATCHED",
    "moreInfo": "collectionName Input does not match the given pattern"
  },
  "status": {
    "code": 400,
    "description": "Invalid Input"
  }
}