Create external collection link API in Zoho WorkDrive

Create External Collection

This API helps create an external collection. The link created here is used to collect files from anyone on the internet.

You can set custom link settings, such as expiration date, file count limit, and file size limit. External users need not sign in to a WorkDrive account to access the collection link and upload files. Learn more about external collections

Endpoints

post https://www.zohoapis.com/workdrive/api/v1/collections

Copy full URL

OAuth Scope

WorkDrive.Collection.CREATECopied!

curl --request POST \
  --url https://www.zohoapis.com/workdrive/api/v1/collections \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"upload_file_size_limit":"250 KB","notify_every_submissions":true,"set_upload_limit":true,"override_name_exist":false,"is_external":true,"input_fields":[{"field_type":"TEXT","is_name_field":true,"field_name":"Name"},{"field_type":"PHONE","field_name":"Phone"},{"field_type":"EMAIL_ID","field_name":"Email"}],"expiration_date":"2021-05-20 11:45","request_user_data":true,"personal_note":"Analysis potential leads and assign them to the Sales team","upload_limit_per_user":"10","each_user_each_folder_fields":["email"],"parent_id":"vx57jc433ffa2c7524c51a5205d1849bc92fa","collection_name":"Event Leads","uploader_note":"Share all leads that you have collected in the recent Dubai Trade Fair"},"type":"collections"}}'

header = Map();
header.put("Accept","application/vnd.api+json");
data=Map();
data_param1=Map();
att_param1=Map();
att_param1.put("upload_file_size_limit","250 KB");
att_param1.put("notify_every_submissions","true");
att_param1.put("set_upload_limit","true");
att_param1.put("override_name_exist","false");
att_param1.put("is_external","true");
innerattr_param=List();
innerattr_param_map1=Map();
innerattr_param_map1.put("field_name","Name");
innerattr_param_map1.put("field_type","TEXT");
innerattr_param_map1.put("is_name_field","true");
innerattr_param.add(innerattr_param_map1);
innerattr_param_map2=Map();
innerattr_param_map2.put("field_name","Phone");
innerattr_param_map2.put("field_type","PHONE");
innerattr_param.add(innerattr_param_map2);
innerattr_param_map3=Map();
innerattr_param_map3.put("field_name","Email");
innerattr_param_map3.put("field_type","EMAIL_ID");
innerattr_param.add(innerattr_param_map3);
att_param1.put("input_fields",innerattr_param);
att_param1.put("expiration_date","2021-05-20 11:45");
att_param1.put("request_user_data","true");
att_param1.put("personal_note","Analysis potential leads and assign them to the Sales team");
att_param1.put("upload_limit_per_user","10");
innerattr_param=List();
innerattr_param.add("email");
att_param1.put("each_user_each_folder_fields",innerattr_param);
att_param1.put("parent_id","vx57jc433ffa2c7524c51a5205d1849bc92fa");
att_param1.put("collection_name","Event Leads");
att_param1.put("uploader_note","Share all leads that you have collected in the recent Dubai Trade Fair");
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"
type : POST
parameters : data.toString()
headers : header
connection : "wdconnection"
];
info response;

Request Body

application/vnd.api+json

dataJSON Object(Required)

Hide Sub-Attributes

attributesJSON Object(Required)

Hide Sub-Attributes

upload_file_size_limitstring(Optional)

To set the maximum file upload size limit.

notify_every_submissionsboolean(Optional)

To notify every user submission with bell notification (web), push notification (mobile), and email notification.

set_upload_limitboolean(Optional)

Set "true" to apply a file upload count limit per user.

override_name_existboolean(Optional)

To upload files with the same name as versions to the existing file; otherwise files will be added separately.

is_externalboolean(Required)

To set the collection link's visibility to either internal organization members or anyone on the internet.

input_fieldsJSON Array(Optional)

The field where the user data such as name, phone number, and email address are collected.

For an external collection link, the name field is mandatory and selected by default.

Show Sub-Attributes

field_typestring(Optional)

Field data type. Supported values include TEXT, EMAIL_ID, PHONE.

is_name_fieldboolean(Optional)

Set true when this field captures the uploader name.

field_namestring(Optional)

User-visible field label.

expiration_datestring(Optional)

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

request_user_databoolean(Required)

To set whether to request user data or not.

For an external collection link, the request user data field is mandatory.

personal_notestring(Optional)

A note is used as a reference by the creator of the collection. This note is only visible to the creator of the collection.

upload_limit_per_userinteger(Optional)

To set the maximum file upload count limit per user.

each_user_each_folder_fieldsarray(Optional)

To create a separate folder for each user to store their files. For an external collection, user name will be the default folder name. If phone numbers and email addresses are requested from users, these can also be set as folder names.

Possible values can be name/email/phone

parent_idstring(Required)

A unique ID of the destination folder where the collected files get uploaded.

collection_namestring(Required)

The name of the collection.

uploader_notestring(Optional)

A note for users who upload via the collection link.

typestring(Required)

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

Allowed Values :

Show Values ▾

  {
    "data": {
      "attributes": {
        "upload_file_size_limit": "250 KB",
        "notify_every_submissions": true,
        "set_upload_limit": true,
        "override_name_exist": false,
        "is_external": true,
        "input_fields": [
          {
            "field_type": "TEXT",
            "is_name_field": true,
            "field_name": "Name"
          },
          {
            "field_type": "PHONE",
            "field_name": "Phone"
          },
          {
            "field_type": "EMAIL_ID",
            "field_name": "Email"
          }
        ],
        "expiration_date": "2021-05-20 11:45",
        "request_user_data": true,
        "personal_note": "Analysis potential leads and assign them to the Sales team",
        "upload_limit_per_user": "10",
        "each_user_each_folder_fields": [
          "email"
        ],
        "parent_id": "vx57jc433ffa2c7524c51a5205d1849bc92fa",
        "collection_name": "Event Leads",
        "uploader_note": "Share all leads that you have collected in the recent Dubai Trade Fair"
      },
      "type": "collections"
    }
  }

▼ Show full

  {
    "data": {
      "id": "vx57jc433ffa2c7524c51a5205d1849bc92fa",
      "type": "collections",
      "attributes": {
        "modified_time_i18": "Aug 9, 5:53 PM",
        "modifier_name": "Anna Baker",
        "link": "https://workdrive.zohoexternal.com/collection/vx57jc433ffa2c7524c51a5205d1849bc92fa/external",
        "input_fields": [
          {
            "id": 0,
            "field_name": "Name",
            "encrypt_field": false,
            "field_type": "TEXT",
            "is_name_field": true,
            "status": 1
          },
          {
            "id": 1,
            "field_name": "Phone",
            "encrypt_field": false,
            "field_type": "PHONE",
            "is_name_field": false,
            "status": 1
          },
          {
            "id": 2,
            "field_name": "Email",
            "encrypt_field": false,
            "field_type": "EMAIL_ID",
            "is_name_field": false,
            "status": 1
          }
        ],
        "each_user_each_folder": true,
        "each_user_each_folder_fields": [
          "email"
        ],
        "expiration_date": "May 20, 2021, 11:45 AM",
        "expiration_date_in_millis": 1621491300000,
        "created_time_i18": "Aug 9, 5:53 PM",
        "request_user_data": true,
        "total_uploads": 11,
        "modified_time": "Aug 9, 5:53 PM",
        "modified_time_in_millis": 1620562320000,
        "total_submissions": 23,
        "upload_file_size_limit_in_bytes": 256000,
        "created_time": "Aug 9, 5:53 PM",
        "notify_every_submissions": true,
        "upload_file_size_limit": "250 KB",
        "set_upload_limit": true,
        "override_name_exist": false,
        "is_external": true,
        "personal_note": "Analysis potential leads and assign them to the Sales team",
        "is_expired": false,
        "upload_limit_per_user": 10,
        "parent_id": "vx57jc433ffa2c7524c51a5205d1849bc92fa",
        "created_time_in_millis": 1620562320000,
        "creator_name": "Anna Baker",
        "space_id": "15532088",
        "collection_name": "Event Leads",
        "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/7lse9afe33b5aa13841d2823067713b701177/relationships/submissions",
            "related": "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177/submissions"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/api/v1/collections/7lse9afe33b5aa13841d2823067713b701177"
      }
    }
  }

  {
    "errors": [
      {
        "id": "COL012",
        "title": "Your current plan does not support the collection feature."
      }
    ]
  }

  {
    "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": "COL005",
        "title": "The expiration date format should be in yyyy-mm-dd or yyyy-m-d hh:mm"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "COL007",
        "title": "Upload limit cannot be less than or equal to zero"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "COL017",
        "title": "Collection creation limit exceeded"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "COL006",
        "title": "The expiration date cannot be in the past"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "COL009",
        "title": "Upload file limit not matching"
      }
    ]
  }

  {
    "errors": [
      {
        "id": "COL008",
        "title": "Input fields cannot be empty"
      }
    ]
  }

  {
    "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