This API is used to upload a new file to your WorkDrive account

Parent folder ID in which file will be uploaded

This API is used to upload a file as the top version to an existing file in your WorkDrive account

resource_id

Once all chunks are uploaded, user can use the commit API to complete the session and create/update the file

If the same name exists (Default option is fail)

Parent folder ID in which the file will be uploaded.

During revision upload, after uploading a new version of an already existing file, in order to finish uploading the chunks and complete the created session, this API is called

A user can use this API to get the status of the chunk upload session

upload_id

This API fetches information about a collection

A unique ID that represents a collection.

collection_id

Set the state as reactivate to enable the collection

This API helps in deleting a specific collection

This API fetches all data submissions made through a collection link

This API fetches the lists of all collection links created by the current user in the given organization

team_id

This API fetches the list of all files submitted by a user using a given link

A unique ID that represents each user's file submission via a collection link

submission_id

This API helps create an internal collection

To create a separate folder for each user to store their files.

The date when the collection link expires.

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

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

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

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

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

To limit the size of a single file during submission.

A note for users who upload via the collection link.

This API fetches all available details of the comment

comment_id

This API adds a reply to an existing comment on a file

The unique ID of the comment to which the reply needs to be added

A unique ID of the team in which the data template is created

This API helps in enabling or disabling a data template

data_template_id

Mention true if you want to keep the data template in an active state, and false to disable the data template

This API helps in creating a custom field within a data template

This represents the list of choices for choice type custom fields (dropdown, radio, checkbox).

Optional. This represents the variables used for different data types.

This represents the data type of the custom field.

This API fetches all custom fields created within a data template

This API helps in updating custom field data

custom_field_id

This represents the variables used for different data types.

This API helps in deleting a custom field

This API helps in associating multiple files or folders to a specific data template

Associate Multiple Files/Folders to Data Template

This API helps in editing the custom filed values provided with the associated files and folder

A unique ID that represents the association of a file/folder to a data template

custommetadata_id

Update Values of Associated Files/Folders

This API disassociates a file or folder from a data template

Disassociate Files/Folders from Data Template

This API fetches information about an external share link

link_id

This API helps in changing the password and to enable or disable password protection for the link

Should be false to disable password protection for the link.

This API deletes a file or folder's external share link

This API creates download external share links for files and folders stored in a team folder or my folders

download_limit - The maximum number of downloads allowed for the link.

This API restores a specific version of a file to be the top version of the file

The version of the file that needs to be set as the top version

This API deletes a specific version of a file

version_id

This API returns sharing information about the file or folder

The unique ID that represents collaboration

permission_id

This API will update the roles of the users with whom the files need to be shared

This API will stop sharing the file/folder and remove access

This API will share the file or folders with all team members in a team

The API response will only have details of the successfully uploaded files

Unique string - for processing each upload.

The name of the file should be URL encoded with UTF-8 Charset.

The unique ID of the folder where files are to be uploaded.

This API uploads a file to a destined team folder or folder in WorkDrive

The multi-part file to be uploaded and the maximum file size is 250 MB.

If set as true, a file with the matching name will be uploaded as a top version over the existing file. If set as false, a file with the matching name will have the timestamp added to it on upload.

The unique ID of folder where files to be uploaded.

This API returns the file content in binary format

Version number of the file, if it is not present, the top version content will be downloaded

version

This API will return all information about a file, which also includes the thumbnail URL of the file

This API permanently deletes a file or a folder from the trash folder

This API fetches all metadata required for previewing the file

This API fetches the current location of the file or folder and the higher-level folders under which the file or folder is stored

This API lists all the comments from a file

This API fetches the list of all external share links created for a file/folder

filter[type]

This API fetches all shared users of a file or folder

This API will return additional properties of the file

This API fetches you complete access stats of the file or folder

This API downloads multiple files/folders in a compressed ZIP format

 The unique IDs of the files to be downloaded

This API uses the WMS key generated using (returned from) the Download Multiple Files/Folders as ZIP to get the content of the compressed ZIP formatted files

 WMS Key which returned from Download Multiple Files/Folders as ZIP

progressid

In Upload API (Stream mode), proper error responses will not be shown. You can use the Upload Progress API to get proper error responses using the upload-id value

uploadid

This API compresses multiple files and folders as a ZIP folder and returns a WMS key

The unique IDs of the file/folder, separated by commas.

This API uses the WMS key returned from the Create Multiple Files/Folders as ZIP API to get the metadata of the compressed ZIP file

WMS Key, which returned from create multiple files/folders as Zip

This API extract files and folders from a ZIP file to a destined folder in WorkDrive

This API automatically converts the imported files into the Zoho format, i.e., Writer, Sheet, and Show

This API copies a collection of files or folders from one destination to another

This API fetches all data templates associated with a specific file or folder

The name of the new folder to be created.

The unique ID of the destination folder/team folder

This API lists down all the files and folders present within a folder

folder_id

Set false to avoid externally uploaded folders.

filter[externalUpload]

Filter resources by their file extensions.

filter[extension]

Limit indicates the number of items to be listed.

page[limit]

Offset pagination returns 50 items by default.

page[offset]

Cursor pagination returns 1000 items by default.

page[next]

Mention the required params to be included in the response attribute.

fields[files]

Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time

sort

This API will remove follow updates for the file or folder

This represents the notification preference settings.

This API is used to generate the starting point token, which is required to check the changes in the WorkDrive account

The unique ID of My Folders, Team Folder, or any sub folder

Set the token value in one of the below methods: latest (to check changes from current time), Milliseconds, Date format (yyyy-mm-dd), Date and time format (yyyy-mm-dd hh:mm:ss)

page[token]

Page limit refers to the total page results you need to view using the API response.

This API provides a list of all files and folders that were modified or added during the given time

Use the page token received from the above API

This API fetches the required information about a group member

group_member_id

This API helps in changing the role of a group member

Allowed values for group member role: 30 - Group Admin, 31 - Group Member.

The unique ID of the group member, who will be removed from the group.

This API helps in adding multiple new members to a WorkDrive group

The unique ID of the group, where one needs to add new members.

The unique ID that represents group members.

group_id

This API fetches information about a group

This API helps in changing the description of a group

This API creates a new user group in a WorkDrive team

label_id

This API helps in changing the label color

This API fetches all the labels created by the user

The unique ID of the team member that is created when a member is added into a team.

team_member_id

A unique ID of the team member that is created when a member is added into a team.

This API helps in adding labels to the required files and folders

This API helps in removing labels from files and folders

This API fetches the ID of the team member's my folders

The unique ID that represents the team member

This API fetches the list of the external share links created for the files/folders inside the team member's my folders

The unique ID that represents team member's my folders

myfolder_id

This API fetches files from the team member's my folders

Filter resources by their file extensions

Limit indicates the number of items to be listed

Offset indicates from where the listing should start

Mention the required params to be included in the response attribute

This API fetches the list of folders inside the team member's my folders

This API fetches files from the trash folder in the team member's my folders

This API will help automatically convert all files to Zoho WorkDrive's format while uploading to the user's my folders

Setting this as true or false will enable or disable automatic conversion of all files to Zoho WorkDrive's format while uploading to the user's my folders.

This API searches for data based on data templates associated with the files

search[all|name|content]

To search resources associated to a specific date template

filter[datatemplate]

To filter files and folders by adding custom field criteria.

filter[customFields]

To search resource by predefined date filter.

filter[date]

filter[fromDate]

filter[toDate]

To search resources by its current state.

filter[status]

filter[creator]

Offset indicates from where the listing should start.

This API clears the files and folders in the team folder trash permanently

This API fetches all the information about a team folder

teamfolder_id

This API fetches all members who are part of a team folder

This API fetches all the files and folders in a team folder

Sorting can be done with these fields: name, kind, shared_time, last_modified, created_time.

This API fetches the list of sub folders in a team folder

This API fetches all share links (i.e., external share links, download links, and embed codes) created in a team folder

This API fetches the settings of a team folder

This API fetches the list of all of the draft files in a team folder

This API fetches all the unread files in a team folder

This API fetches all the files in a team folder's Trash

This API creates a new team folder in a team

Mention true to make the team folder type 'Public'. Mention false to make the team folder type 'Private'

This API will help in enabling automatic conversion of all files to Zoho WorkDrive's format on upload

Setting this as true or false will respectively enable or disable automatic conversion of all files to Zoho WorkDrive's format on upload

This API will add a WorkDrive Group to the team folder