−

Update Collection Link Settings

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API helps you update the collection link settings, such as expiration date, file count limit, and file size limit.

Endpoints

patch https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}

Copy full URL

OAuth Scope

WorkDrive.Collection.UPDATECopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request PATCH \
  --url https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id} \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"upload_limit_per_user":false,"expiration_date":"never","collection_name":"Event Leads - Dubai","each_user_each_folder":false},"type":"collections"}}'
header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("upload_limit_per_user","false");
att_param1.put("expiration_date","never");
att_param1.put("collection_name","Event Leads - Dubai");
att_param1.put("each_user_each_folder","false");
data_param1.put("attributes",att_param1);
data_param1.put("type","collections");
data.put("data",data_param1);
response = invokeurl
[
url : "https://www.zohoapis.com/workdrive/api/v1/collections/{collection_id}"
type : PATCH
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Path Parameters

collection_idstring(Required)

A unique ID that represents a collection.

Request Body

application/vnd.api+json
dataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
upload_limit_per_userinteger(Optional)

To set the maximum upload count limit per user.

expiration_datestring(Optional)

The date when the collection link expires. Date should be in the format of YYYY-MM-dd / YYYY-MM-dd HH:mm

collection_namestring(Optional)

The name of the collection

each_user_each_folderboolean(Optional)

Set "each_user_each_folder" as false if you do not want to create a separate folder for each user who uploads files using the collection link.

Set "each_user_each_folder_fields" as email/name/phone if you want to create a separate folder for each user who uploads files using the collection link.

typestring(Required)

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

Allowed Values :
Show Values ▾
collectionsCopied!
Copied!Copy all as JSON Array

Body Parameters

Copied!
  {
    "data": {
      "attributes": {
        "upload_limit_per_user": false,
        "expiration_date": "never",
        "collection_name": "Event Leads - Dubai",
        "each_user_each_folder": false
      },
      "type": "collections"
    }
  }
                
▼ Show full

Response Example

COL020

COL001

COL001

COL011

COL022

COL014

COL005

COL015

COL007

COL006

COL009

COL010

COL021

200
200
403
422
Copied!
  {
    "data": {
      "id": "vx57jc433ffa2c7524c51a5205d1849bc92fa",
      "type": "collections",
      "attributes": {
        "modified_time_i18": "May 9, 5:42 PM",
        "modifier_name": "Anna Baker",
        "link": "https://www.zohoapis.com/workdrive/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa",
        "input_fields": [],
        "each_user_each_folder": false,
        "expiration_date_in_millis": -1,
        "created_time_i18": "Aug 9, 5:42 PM",
        "request_user_data": false,
        "total_uploads": 11,
        "modified_time": "May 9, 5:42 PM",
        "modified_time_in_millis": 1620562320000,
        "total_submissions": 23,
        "upload_file_size_limit_in_bytes": 10485760,
        "created_time": "May 9, 5:42 PM",
        "notify_every_submissions": true,
        "upload_file_size_limit": "10 MB",
        "set_upload_limit": false,
        "override_name_exist": false,
        "is_external": false,
        "personal_note": "Analysis potential leads and assign them to the Sales team",
        "is_expired": false,
        "upload_limit_per_user": 0,
        "parent_id": "vx57jc433ffa2c7524c51a5205d1849bc92fa",
        "created_time_in_millis": 1620562320000,
        "creator_name": "Anna Baker",
        "space_id": "15532088",
        "collection_name": "Event Leads - Dubai",
        "uploader_note": "Share all leads that you have collected in the recent Dubai Trade Fair",
        "status": 1
      },
      "relationships": {
        "submissions": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/relationships/submissions",
            "related": "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d/submissions"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/api/v1/collections/7lse92d3ced8a860d4efca7ba1648f7e3f69d"
      }
    }
  }
                
  {
    "errors": [
      {
        "id": "COL020",
        "title": "Collection disabled by the admin"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL001",
        "title": "Invalid collection name"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL011",
        "title": "For link visibility with 'Anyone on the Internet', the request user data attribute is mandatory"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL022",
        "title": "Only name parameter applicable for internal collection"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL014",
        "title": "Collection not in an active state"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL005",
        "title": "The expiration date format should be in yyyy-mm-dd or yyyy-m-d hh:mm"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL015",
        "title": "To re-enable or delete a collection, it must be in a completed state"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL007",
        "title": "Upload limit cannot be less than or equal to zero"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL006",
        "title": "The expiration date cannot be in the past"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL009",
        "title": "Upload file limit not matching"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL010",
        "title": "Invalid file size format"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "COL021",
        "title": "Each user each folder field must be in anyone of request user data"
      }
    ]
  }
                
▼ Show full

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.