Skip to main content
Zoho WorkDrive logo
  • Category: file management & storage
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 220
  • Triggers: 0
  • Slug: ZOHO_WORK_DRIVE
  • Version: 20261101_00

Tools

Slug: ZOHO_WORK_DRIVE_ABORT_WORKFLOW_FOR_A_FILE_FOLDERAbort an active workflow instance permanently after exact-ID confirmation; an aborted instance cannot be resumed.

Input Parameters

string
required
Unique ID of the active workflow instance to abort.
string
required
Repeat instance_id exactly to confirm the irreversible workflow abort.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ADD_COMMENTCreate a new top-level comment on a WorkDrive file.

Input Parameters

string
required
Unique ID of the file to comment on.
string
required
Comment content in supported HTML.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ADD_FOLDER_CUSTOMIZATIONEnable customization for an existing WorkDrive folder.

Input Parameters

string
required
Unique ID of the folder to customize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ADD_MEMBER_IN_GROUPAdd one Zoho user to a WorkDrive group with a specified group role.

Input Parameters

integer ("30" | "31")
required
Group role: 30 for Group Admin or 31 for Group Member.
string
required
Unique ID of the WorkDrive group receiving the member.
string
required
Zoho user ID of the member to add.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ADD_REPLYCreate a reply to an existing WorkDrive comment.

Input Parameters

string
required
Unique ID of the file containing the thread.
string
required
Reply content in supported HTML.
string
required
Unique ID of the parent comment to reply to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ADD_RESOURCE_LABELSApply a WorkDrive label to a file or folder.

Input Parameters

string
required
Unique ID of the label.
string
required
Unique ID of the file or folder to label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ALLOW_DOCUMENT_CONVERSIONEnable or disable automatic document conversion for a team folder.

Input Parameters

boolean
required
Whether to enable automatic document conversion.
string
required
Unique ID of the team folder to configure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ALLOW_EXTERNAL_SHAREEnable or disable external sharing for a team folder.

Input Parameters

boolean
required
Whether to allow external sharing from the team folder.
string
required
Unique ID of the team folder to configure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ALLOW_USER_DOCUMENT_CONVERSIONEnable or disable automatic document conversion for a member’s My Folders space.

Input Parameters

boolean
required
Whether to enable automatic document conversion.
string
required
Unique ID of the team member’s My Folders space.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ALLOW_VIEWER_DOWNLOADAllow or prevent viewer-level users from downloading team-folder files.

Input Parameters

boolean
required
Whether viewers may download files from the team folder.
string
required
Unique ID of the team folder to configure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ARCHIVE_TEAM_FOLDERArchive a team folder while preserving its data, roles, and sharing permissions.

Input Parameters

string
required
Unique ID of the active team folder to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ASSOCIATE_FILE_FOLDER_TO_DATA_TEMPLATEAssociate one file or folder with a data template and field values.

Input Parameters

array
Custom field IDs and values for the association.
string
required
Unique file or folder ID.
string
required
Unique data template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ASSOCIATE_MULTIPLE_FILE_FOLDER_TO_DATA_TEMPLATEAssociate multiple files or folders with data templates in one request.

Input Parameters

array
required
Files or folders and their data-template values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_BREADCRUMBS_OF_FILEFetch the location and folder hierarchy of a WorkDrive file or folder.

Input Parameters

string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHANGE_DATA_TEMPLATE_DESCRIPTIONChange the description of an existing data template.

Input Parameters

string
required
New description for the data template.
string
required
Unique ID of the data template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHANGE_LABEL_COLORChange only the color of an existing WorkDrive label.

Input Parameters

string
required
New six-digit hexadecimal color code without a leading hash.
string
required
Unique ID of the label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHANGE_PREFERRED_TEAMSet a WorkDrive team as the authenticated user’s preferred team, which becomes the default team shown after login.

Input Parameters

string
required
Unique ID of the team to make the preferred team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHECKOUT_RESOURCECheck out a WorkDrive file to restrict other users from editing it.

Input Parameters

string
required
Unique ID of the WorkDrive file to check out.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHUNK_REVISION_UPLOAD_COMMIT_SESSIONCommit a completed chunk upload session as the top version of an existing WorkDrive file.

Input Parameters

string
required
Upload ID returned when the revision upload session was created.
string
required
ID of the existing WorkDrive file receiving the uploaded revision.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHUNK_REVISION_UPLOAD_CREATE_SESSIONCreate a chunk upload session for a new top version of an existing WorkDrive file.

Input Parameters

string
required
Size of the new file version, in bytes, encoded as a decimal string.
string
required
ID of the existing WorkDrive file that will receive a new top version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHUNK_UPLOAD_COMMIT_SESSIONCommit a completed chunk upload session and create or update its file.

Input Parameters

string
Optional name for the uploaded file.
string
required
ID of the parent folder in which to create the uploaded file.
string
required
Upload ID returned when the chunk upload session was created.
string ("fail" | "rename" | "update")
How to handle an existing file with the same name: fail, rename, or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHUNK_UPLOAD_CREATE_SESSIONCreate a WorkDrive chunk upload session for a new file.

Input Parameters

string
required
Size of the file to upload, in bytes, encoded as a decimal string.
string
required
Name of the file to upload.
string
required
ID of the parent folder in which to upload the file.
string ("fail" | "rename" | "update")
How to handle an existing file with the same name: fail, rename, or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CHUNK_UPLOAD_STATUSReturn progress details for an ongoing WorkDrive chunk upload session.

Input Parameters

string
required
Upload ID returned when the chunk upload session was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_COPY_RESOURCECopy one WorkDrive file or folder into a destination folder.

Input Parameters

string
required
ID of the file or folder to copy.
string
required
ID of the destination folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_CUSTOM_FIELDCreate a custom field within an existing data template.

Input Parameters

array
Choices for dropdown, radio, or checkbox fields.
string
required
Name for the custom field.
string
required
Unique ID of the data template.
object
Type-specific custom field properties.
string ("text" | "multiline_text" | "number" | "datetime" | "date" | "yes_or_no" | "dropdown" | "radio" | "checkbox" | "email" | "multi_email")
required
Data type for the custom field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_CUSTOMIZED_FOLDERCreate a WorkDrive folder with folder customization enabled.

Input Parameters

string
required
Name of the customized folder to create.
string
required
Unique ID of the destination folder or team folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_DATA_TEMPLATECreate a new data template in a specified WorkDrive team.

Input Parameters

string
required
Name for the new data template.
string
required
Unique ID of the WorkDrive team in which to create the data template.
string
Optional description of the new data template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_EXTERNAL_COLLECTIONCreate a collection link that accepts files from people outside the WorkDrive team.

Input Parameters

string
Destination folder ID for collected files.
array
Uploader data fields; when supplied, include a name field marked is_name_field.
string
Private reference note visible to the creator.
string
Instructions shown to uploaders.
string
Collection name.
string
Expiration in YYYY-MM-dd or YYYY-MM-dd HH:mm format.
boolean
Whether to enforce a per-uploader file-count limit.
boolean
Whether to request uploader data; required for an external collection.
boolean
Whether same-name uploads become versions of an existing file.
integer
Maximum files each uploader may submit.
string
Maximum size of one uploaded file, such as 250 KB.
boolean
Whether to notify the creator for every submission.
array
Uploader fields WorkDrive may use to name per-uploader folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_FOLDERCreate an ordinary folder inside a folder or team folder.

Input Parameters

string
required
New folder name, up to 200 characters.
string
required
Destination folder or team-folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_GROUPCreate a new WorkDrive group in a specified team or organization.

Input Parameters

string
required
Name of the new group.
integer ("1" | "2")
required
Group type: 1 for a WorkDrive group or 2 for a Zoho One group.
string
required
Unique ID of the parent team.
string
Detailed description of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_INTERNAL_COLLECTIONCreate a collection link restricted to signed-in members of the WorkDrive team.

Input Parameters

string
Destination folder ID for collected files.
string
Private reference note visible to the creator.
string
Instructions shown to uploaders.
string
Collection name.
string
Expiration in YYYY-MM-dd or YYYY-MM-dd HH:mm format.
boolean
Whether same-name uploads become versions of an existing file.
string
Maximum size of one uploaded file, such as 10 MB.
boolean
Whether to notify the creator for every submission.
array
Use name to create a separate named folder for each team uploader.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_LABELCreate a WorkDrive label for a specific team member.

Input Parameters

string
required
Name of the new label.
string
required
Six-digit hexadecimal color code without a leading hash.
string
required
Unique team-member ID that will own the label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_NEW_FILECreate an empty Zoho Writer, Sheet, or Show file in WorkDrive.

Input Parameters

string
required
Name of the new native Zoho Office file.
string
required
ID of the folder or team folder that will contain the file.
string ("zohosheet" | "zw" | "zohoshow")
required
Native file type: zohosheet, zw (Writer), or zohoshow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_TEAM_FOLDERCreate a public or private team folder in a WorkDrive team.

Input Parameters

string
required
Name of the new team folder.
string
required
Unique ID of the team in which to create the team folder.
string
Optional description of the new team folder.
boolean
required
Set true for a public team folder or false for a private team folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_TEMPLATE_CATEGORYCreate a category in a My Templates or Org Templates library.

Input Parameters

string
required
ID of the My Templates or Org Templates library in which to create the category.
string
required
Name of the new template category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_CREATE_ZIP_FILECreate a ZIP file in WorkDrive from selected files and folders.

Input Parameters

string
required
Name for the ZIP file.
string
required
Comma-separated WorkDrive file or folder IDs to include in the ZIP.
string
required
ID of the folder in which to create the ZIP file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_COLLECTIONPermanently delete a WorkDrive file collection after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the collection to delete.
string
required
Repeat collection_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_COMMENTPermanently delete one WorkDrive comment or reply. This cannot be undone and requires the exact comment ID twice.

Input Parameters

string
required
Exact ID of the comment or reply to permanently delete.
string
required
Repeat comment_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_CUSTOM_FIELDPermanently delete a custom field after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the custom field to delete.
string
required
Repeat custom_field_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_DATA_TEMPLATEPermanently delete a data template after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the data template to delete.
string
required
Repeat data_template_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_GROUPPermanently delete a WorkDrive group and remove all of its memberships after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the group to delete.
string
required
Repeat group_id exactly to confirm permanent deletion of the group and its memberships.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_LABELPermanently delete a WorkDrive label after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the label to delete.
string
required
Repeat label_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_MEMBERRemove one existing member from a WorkDrive group after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the group membership to remove.
string
required
Repeat group_member_id exactly to confirm removal from the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_RESOURCEPermanently delete one WorkDrive file or folder from trash.

Input Parameters

string
required
Unique ID of the trashed WorkDrive file or folder to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_TEAM_FOLDERPermanently delete a WorkDrive team folder after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the team folder to permanently delete.
string
required
Repeat teamfolder_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_TEAM_FOLDER_MEMBERRemove one user or group from a WorkDrive team folder after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the team-folder membership to remove.
string
required
Repeat member_id exactly to confirm removal from the team folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_TEMPLATE_CATEGORYMarks the specified template category deleted using WorkDrive status 61.

Input Parameters

string
required
The template category ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_USERRemove a member from a WorkDrive team. This is destructive: the member loses team access. All My Folders content transfers to ownership_transfer_id, only Team Folder Admin roles transfer, other Team Folder roles do not, and existing share permissions are retained. The official API does not document sending a notification.

Input Parameters

string
required
Team-member ID to remove, in the provider’s {team-id}-{member-id} form.
string
required
Active recipient team-member ID that will receive the removed member’s data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DELETE_VERSIONPermanently delete one historical WorkDrive file version. This cannot delete the current top version, cannot be undone, and requires the exact version ID twice.

Input Parameters

string
required
Exact ID of the historical file version to delete.
string
required
Repeat version_id exactly to confirm permanent deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DISABLE_COLLECTIONStop an active WorkDrive file collection from accepting submissions.

Input Parameters

string
required
Unique ID of the active collection to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DISASSOCIATE_FILES_FOLDERS_FROM_DATA_TEMPLATERemove a file/folder and data-template association after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the file/folder and data-template association.
string
required
Repeat custommetadata_id exactly to confirm disassociation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DOWNLOAD_PROGRESSCheck whether a WorkDrive multi-download ZIP is complete or still processing.

Input Parameters

string
required
Progress ID in {zuid}_{wms_key} format returned by multi-download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_DOWNLOAD_SERVER_FILEDownload the binary content of a WorkDrive file or a specific version. Supported connection regions are US, EU, India, Australia, China, Japan, Canada, and Saudi Arabia.

Input Parameters

string
Specific file version to download.
string
required
Unique ID of the WorkDrive file to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_EDIT_COMMENTReplace the content of an existing WorkDrive comment.

Input Parameters

string
required
Unique ID of the comment to edit.
string
required
Replacement comment content in HTML.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_EMPTY_MY_FOLDERS_TRASHPermanently delete every item in one My Folders trash. This has no restore or dry-run operation and requires the exact My Folders ID twice.

Input Parameters

string
required
ID of the My Folders space whose entire trash to empty.
string
required
Repeat my_folder_id exactly to confirm permanent deletion of all trash items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_EMPTY_TEAM_FOLDER_TRASHPermanently delete every item in one team folder’s trash. This has no restore or dry-run operation and requires the exact team-folder ID twice.

Input Parameters

string
required
ID of the team folder whose entire trash to empty.
string
required
Repeat team_folder_id exactly to confirm permanent deletion of all trash items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ENABLE_COLLECTIONReactivate a completed WorkDrive file collection.

Input Parameters

string
required
Unique ID of the completed collection to reactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ENABLE_DISABLE_DATA_TEMPLATEEnable or disable an existing data template.

Input Parameters

boolean
required
True to enable the template; false to disable it.
string
required
Unique ID of the data template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_EXTERNAL_TO_INTERNALRestrict an external WorkDrive collection to signed-in team users.

Input Parameters

string
required
Unique ID of the external collection to make internal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_FILE_PROPERTYFetch storage, retention, DLP, and additional properties for a resource.

Input Parameters

string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_FILE_QUERYAsk Zia a question about a WorkDrive file and inspect indexing status.

Input Parameters

string
required
Question to answer from the indexed file content.
string
required
Unique ID of the file to query.
string
required
Organization or team ID used as the WorkDrive account context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_FOLLOW_RESOURCEFollow one or more WorkDrive files or folders. Email and bell notifications are both enabled by default; set either notification option false to disable it.

Input Parameters

boolean
Whether to show followed-resource updates in the bell.
boolean
Whether to send followed-resource updates by email.
array
required
Unique IDs of the files or folders to follow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GENERATE_EMBEDPublish a WorkDrive file or folder with view-only access for embedding. This creates persistent publish access that may expose the resource outside its current collaborators until revoked.

Input Parameters

string
required
Unique WorkDrive file or folder ID to publish for embedding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GENERATE_FILE_SUMMARYAsk WorkDrive to generate an AI summary of a specified file.

Input Parameters

string
required
ID of the WorkDrive file to summarize.
string
required
ID of the WorkDrive team or organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_ACTIONS_FOR_A_TRANSITIONFetch the during or after actions configured for a workflow transition.

Input Parameters

string ("during" | "after")
Return actions configured for the during or after stage.
string
required
Unique ID of the workflow transition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_COLLABORATION_INFORetrieve the audience, role, status, and expiration details for one existing WorkDrive file or folder collaboration permission.

Input Parameters

string
required
Unique collaboration permission ID for a WorkDrive file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_COLLECTION_INFORetrieve the settings and current state of a WorkDrive file collection.

Input Parameters

string
required
Unique ID of the collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_COMMENT_INFORetrieve detailed information about a specific WorkDrive comment.

Input Parameters

string
required
Unique ID of the WorkDrive comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_CURRENT_TEAM_USERReturn the authenticated user’s membership details for a specific WorkDrive team.

Input Parameters

string
required
Unique ID of the WorkDrive team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_CURRENT_USERReturn the authenticated WorkDrive user’s identity and account capabilities for ID and team discovery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_DT_ASSOC_WITH_FILE_FOLDERFetch data-template metadata associated with a WorkDrive file or folder.

Input Parameters

string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_DURING_ACTIONS_FOR_AN_INSTANCE_TRANSITIONRetrieve the during-actions configured for a transition in a workflow instance.

Input Parameters

string
required
Unique ID of the workflow instance.
string
required
Transition ID whose during-actions to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_FILE_PREVIEWRetrieve preview URLs, status, and size metadata for a WorkDrive file.

Input Parameters

string
required
Unique ID of the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_FILE_STATISTICSFetch view, download, upload, and link activity for a WorkDrive resource.

Input Parameters

string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_FILE_SUMMARYRetrieve a WorkDrive file summary or its current generation status.

Input Parameters

string
required
Unique ID of the file whose summary to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_FILE_THUMBNAILFetch file details and the provider-hosted thumbnail URL when available.

Input Parameters

string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_GROUP_INFORetrieve detailed information about a specific WorkDrive group.

Input Parameters

string
required
Unique ID of the group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_GROUP_MEMBER_INFORetrieve detailed information about one WorkDrive group member.

Input Parameters

string
required
Unique ID of the group membership to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_LABELRetrieve the details of a specific WorkDrive label.

Input Parameters

string
required
Unique ID of the label to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_MEMBER_INFORetrieve profile, status, and role information for one WorkDrive team member.

Input Parameters

string
required
Unique team-member ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_MY_FOLDER_IDReturn the My Folders private-space ID for a WorkDrive team member.

Input Parameters

string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_RESOURCEReturn metadata for one WorkDrive file or folder by resource ID.

Input Parameters

string
required
WorkDrive file or folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_START_TOKENCreate a start token for monitoring changes under My Folders, a team folder, or a subfolder from a point within the last 31 days.

Input Parameters

integer
Maximum change records requested in a page (1-1000). WorkDrive defaults to 50.
string
required
Change observation start point: latest, Unix milliseconds, YYYY-MM-DD, or YYYY-MM-DD HH:MM:SS. The time must be within the last 31 days.
string
required
Unique ID of My Folders, a team folder, or a subfolder to monitor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEAM_FOLDER_SETTINGRetrieve sharing, conversion, download, and retention settings for a team folder.

Input Parameters

string
required
Unique ID of the team folder whose settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEAM_FOLDERS_INFORetrieve metadata and access capabilities for one WorkDrive team folder.

Input Parameters

string
required
Unique ID of the team folder to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEAM_INFOReturn profile and configuration details for a WorkDrive team, including its name, description, member counts, and current-user permissions.

Input Parameters

string
required
Unique ID of the WorkDrive team to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEAM_SETTINGRetrieve administrator-level sharing, storage, retention, and feature settings for a WorkDrive team. Requires a team administrator role.

Input Parameters

string
required
Unique ID of the WorkDrive team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEMPLATE_CATEGORY_INFORetrieves information for a specific template category using the category ID.

Input Parameters

string
required
The template category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_TEMPLATE_LIBRARYRetrieves the details of a specific template library using its library ID.

Input Parameters

string
required
Template library ID for My Templates, Org Templates, or Public Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_VERSIONRetrieve the version records returned for a WorkDrive file.

Input Parameters

string
required
Unique ID of the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_GET_WORKFLOW_INSTANCERetrieve one workflow instance with its state, transitions, and metadata.

Input Parameters

string
required
Unique ID of the workflow instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_IMPORT_TO_NATIVEConvert a supported WorkDrive file into a native Zoho Office file.

Input Parameters

string
required
Name for the converted native file.
string
required
ID of the non-native WorkDrive file to convert.
string
required
ID of the destination folder for the converted file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_INTERNAL_TO_EXTERNALOpen an internal WorkDrive collection to external uploaders and configure requested uploader data.

Input Parameters

array
required
Uploader fields to request; include one TEXT field with is_name_field true.
string
required
Unique ID of the internal collection to make external.
boolean
Whether the external collection requests uploader data; external collections require this.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_INVITE_NEW_USERSInvite one email address to a WorkDrive team with a Member, Admin, or Super Admin role. This creates an invitation addressed to the supplied email; the official API does not expose a notification toggle. The request can consume a licensed user seat.

Input Parameters

integer ("30" | "31" | "32")
required
Invited role: 30 Member, 31 Admin, or 32 Super Admin.
string
required
Email address to which WorkDrive sends the team invitation.
string
required
Team ID the recipient is invited to join.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_COLLECTION_SUBMISSIONSList one offset-based page of submissions received through a collection.

Input Parameters

string
Maximum submissions to return, represented as a string from 1 through 50.
string
Zero-based result offset represented as a non-negative integer string.
string
required
Unique ID of the collection whose submissions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_COMMENTSFetch the comments and replies returned for a WorkDrive file.

Input Parameters

string
required
Unique ID of the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_DATA_TEMPLATE_CUSTOM_FIELDSRetrieve the custom fields configured for a data template.

Input Parameters

string
required
Unique ID of the data template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_FAVORITE_FILESReturn one offset page of files favorited by a WorkDrive team member.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; prefix with a minus for descending order.
integer
Maximum files to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_FOLDER_ITEMSList direct child files and folders inside an ordinary WorkDrive folder.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; a leading minus requests descending order.
string
Cursor from a previous response; use 0 to begin cursor pagination.
array
Resource attribute names to request, such as name, parent_id, and capabilities.
string
required
Ordinary WorkDrive folder ID whose direct children should be listed.
array
File extensions to include, such as docx and jpeg.
integer
Maximum items to return in this page (1-50).
integer
Zero-based result offset for the page.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
boolean
Whether to include externally uploaded folders; omit to return all children.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_GROUP_MEMBERSRetrieve the members of a specific WorkDrive group.

Input Parameters

string
required
Unique ID of the group whose members to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_LABELED_FILESReturn one offset page of labeled files for a WorkDrive team member.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; prefix with a minus for descending order.
string
Return only files assigned this label ID.
integer
Maximum files to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_LABELSRetrieve all labels associated with a WorkDrive team member.

Input Parameters

string
required
Unique team-member ID whose labels should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_MY_DRAFT_FILESReturn one offset page of the connected user’s drafts in a team folder.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; prefix with a minus for descending order.
integer
Maximum drafts to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique ID of the team folder whose drafts to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_MY_FOLDER_FILESReturn one cursor or offset page of files from a My Folders space.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; a leading minus requests descending order.
string
Continuation cursor from a previous response; omit for the first page.
array
Optional resource attributes to request from WorkDrive.
array
File extensions to include, without leading dots.
integer
Maximum resources in offset mode (1-50).
string
required
Unique ID of the team member’s My Folders space.
integer
Zero-based offset; omit to use cursor mode.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_MY_FOLDER_SUBFOLDERSReturn one offset page of folders from a My Folders space.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; a leading minus requests descending order.
integer
Maximum folders to return (1-50).
string
required
Unique ID of the team member’s My Folders space.
integer
Zero-based result offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_MY_FOLDER_TRASHReturn one offset page of trashed resources from a My Folders space.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; a leading minus requests descending order.
integer
Maximum trashed resources to return (1-50).
string
required
Unique ID of the team member’s My Folders space.
integer
Zero-based result offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_MY_TEAMSReturn WorkDrive teams available to the authenticated user without requiring a user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_PUBLIC_TEMPLATE_LIBRARIESRetrieves one provider page of public template libraries.

Input Parameters

string
Optional library-space filter; use template.
string
Optional template-library type filter; use 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_RECENT_CHANGESReturn one page of recent file and folder changes from a WorkDrive start or continuation token.

Input Parameters

string
required
Start token from Get Start Token, or next_cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_RECENT_FILESReturn one offset page of files recently accessed by a WorkDrive team member.

Input Parameters

integer
Maximum files to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_RESOURCE_COLLABORATORSList people and permission records that currently have access to a WorkDrive file or folder.

Input Parameters

string
required
File or folder ID whose collaborators should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_RESOURCE_WORKFLOW_INSTANCESList workflow instances associated with a specific WorkDrive file or folder.

Input Parameters

string ("in_progress" | "completed")
Return only in-progress or completed instances.
integer
Maximum instances to return (1-50).
integer
Zero-based result offset.
string
required
Unique ID of the file or folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_SHARED_WITH_ME_FILESReturn one offset page of files shared with a WorkDrive team member.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; prefix with a minus for descending order.
integer
Maximum files to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique WorkDrive team-member ID.
string
Return only files shared by this user’s Zoho ID.
string
Return only files shared to this WorkDrive group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_SHARED_WITH_ME_FOLDERSReturn one offset page of folders shared with a WorkDrive team member.

Input Parameters

integer
Maximum folders to return (1-50).
integer
Zero-based result offset.
string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_SUBMISSION_FILESList the files uploaded in a specific WorkDrive collection submission.

Input Parameters

string
required
Submission ID in the provider’s collection_id-user_id form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_SUGGESTED_FILESList file suggestions for a WorkDrive team member, optionally filtered by suggestion source.

Input Parameters

string ("user_accessed" | "community_accessed" | "all")
Suggestion source: the member’s activity, collaborator activity, or all organization activity.
string
required
Unique WorkDrive team-member ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_DATA_TEMPLATESReturn the data templates available in a specific WorkDrive team.

Input Parameters

string
required
Unique ID of the WorkDrive team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_FOLDER_ITEMSList one page of files and folders at the root of a WorkDrive team folder, with optional resource type, extension, projection, cursor, and sort controls. The connected account’s WorkDrive plan must support this API.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "size" | "extension" | "type" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time" | "-size" | "-extension" | "-type")
Sort field; a leading minus requests descending order.
string
Cursor from a previous response; use 0 to begin cursor pagination.
array
Resource attribute names to request, such as name, parent_id, and capabilities.
array
File extensions to include, such as docx and jpeg. Do not include leading dots.
integer
Maximum items to return in this page (1-50).
integer
Zero-based result offset for the page.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Team folder ID returned by List Team Folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_FOLDER_MEMBERSRetrieve members and roles shared on a WorkDrive team folder.

Input Parameters

string
required
Unique ID of the team folder whose members to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_FOLDERSList the team folders in a WorkDrive team, optionally filtering by membership type.

Input Parameters

string
required
WorkDrive team ID returned by List My Teams.
integer
Maximum team folders to return in this page (1-50).
integer
Zero-based result offset for the page.
string
Provider team-folder membership filter; omit to include all accessible team folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_FOLDER_SUBFOLDERSReturn one offset page of subfolders in a WorkDrive team folder.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; prefix with a minus for descending order.
integer
Maximum folders to return (1-50).
integer
Zero-based result offset.
string
required
Unique ID of the team folder whose subfolders to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_FOLDER_TRASHReturn one offset page of trashed resources from a WorkDrive team folder.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; prefix with a minus for descending order.
integer
Maximum trashed resources to return (1-50).
integer
Zero-based result offset.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique ID of the team folder whose trash to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_GROUPSReturn one offset-based page of groups belonging to a WorkDrive team, optionally filtered by group type.

Input Parameters

string
required
Unique ID of the WorkDrive team.
string ("1" | "2")
Group type: 1 for a WorkDrive group or 2 for a Zoho One group.
integer
Maximum groups to return in this page (1-50).
integer
Zero-based result offset for this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_TEMPLATE_LIBRARIESRetrieves one provider page of template library details for the specified team.

Input Parameters

string
required
The unique ID that represents a WorkDrive team.
string
Optional template-library type filter; use 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_USERSReturn members of a WorkDrive team, optionally selecting member ZUIDs or searching by keyword.

Input Parameters

Keyword used to search team members.
string
required
Unique ID of the WorkDrive team.
string
One member ZUID or multiple comma-separated ZUIDs to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEAM_WORKFLOWSRetrieve the workflows configured for a WorkDrive team.

Input Parameters

string
required
Unique ID of the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEMPLATE_CATEGORY_FILESRetrieves one provider page of template files under the specified template category.

Input Parameters

string
Provider sort field; prefix it with a minus sign for descending order.
string
required
The template category ID.
string ("documents" | "spreadsheets")
Template type: Writer documents or Sheet spreadsheets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEMPLATE_LIBRARY_CATEGORIESRetrieves one provider page of template categories in a specified template library.

Input Parameters

string
required
Template library ID for My Templates, Org Templates, or Public Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEMPLATE_LIBRARY_FILESRetrieves one provider page of template files from the specified template library.

Input Parameters

string
Provider sort field; prefix it with a minus sign for descending order.
string
required
Template library ID for My Templates, Org Templates, or Public Templates.
string
Only return templates in this template category.
string ("documents" | "spreadsheets")
Template type: Writer documents or Sheet spreadsheets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_TEMPLATE_LIBRARY_PERMISSIONSRetrieves one provider page of sharing permissions for a template library.

Input Parameters

string
required
Template library ID for My Templates, Org Templates, or Public Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_UNREAD_FILESReturn unread resources in a WorkDrive team folder, optionally filtered by type.

Input Parameters

string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.
string
required
Unique ID of the team folder whose unread files to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_USER_COLLABORATORSReturn users and groups with whom a WorkDrive team member has shared files or folders.

Input Parameters

string
Set to ‘sharetome’ to return people and groups that shared items with this member.
string
required
Unique team-member ID whose collaborators to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_USER_GROUPSReturn the WorkDrive groups to which a specified team member belongs.

Input Parameters

integer
Set to 1 to return WorkDrive groups.
string
required
Unique team-member ID whose groups to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_USER_TEMPLATE_LIBRARIESRetrieves one provider page of template library details for the specified team member.

Input Parameters

string
Optional template-library type filter; use 2.
string
required
Team-member ID in team-id-member-id form, returned by the current-user API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_USER_WORKFLOW_INSTANCESList workflow instances created by or assigned to a WorkDrive team member.

Input Parameters

string ("initiated_time" | "status_changed_time" | "-initiated_time" | "-status_changed_time")
Sort field; prefix with a minus for descending order.
integer
Maximum instances to return (1-50).
integer
Zero-based result offset.
string ("assignee" | "creator")
required
Whether the member is the workflow assignee or creator.
string
Optional resource-type category.
string ("today" | "yesterday" | "last_week" | "last_30_days")
Optional predefined initiation-time window.
string
required
Unique ID of the team member.
string ("automatic" | "manual_start")
Optional automatic or manual-start initiation type.
string ("in_progress" | "completed" | "aborted")
Optional workflow-instance status.
integer
Optional range end in Unix milliseconds.
integer
Optional range start in Unix milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_WORKFLOW_INSTANCESList instances created from a specific workflow, with status, state, and time filters.

Input Parameters

string ("initiated_time" | "-initiated_time")
Sort by initiation time; prefix with a minus for descending order.
integer
Maximum instances to return (1-50).
integer
Zero-based result offset.
string
required
Unique ID of the workflow definition.
string ("today" | "yesterday" | "last_week" | "last_30_days")
Optional predefined initiation-time window.
string ("in_progress" | "completed" | "aborted")
Optional workflow-instance status.
string
Only return instances currently in this workflow-state ID.
integer
Optional range end in Unix milliseconds.
integer
Optional range start in Unix milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_LIST_WORKFLOW_TRANSITION_USERSList pending or completed assignees and approvers for a workflow-instance transition.

Input Parameters

string ("in_progress" | "completed")
Return pending (in_progress) or completed transition users.
integer
Maximum users to return (1-50).
string
required
Unique ID of the workflow instance.
integer
Zero-based result offset.
string
required
Transition ID whose pending or completed users to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MARK_AS_READYMark a newly created WorkDrive file as ready for use.

Input Parameters

string
required
Unique ID of the WorkDrive file to mark as ready.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MARK_FAVORITE_MULTIPLEMark one or more WorkDrive files or folders as favorites.

Input Parameters

array
required
Unique IDs of the files or folders to mark as favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MARK_FILE_FAVORITEMark one WorkDrive file or folder as a favorite.

Input Parameters

string
required
Unique ID of the WorkDrive file or folder to favorite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MARK_FINALMark a WorkDrive file as final so it can no longer be edited.

Input Parameters

string
required
Unique ID of the WorkDrive file to mark as final.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MARK_INDEX_LAYOUT_FILESet a WorkDrive Writer file as its folder’s default Index View.

Input Parameters

string
required
Unique ID of the WorkDrive Writer file to use as its folder’s Index View.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MOVE_RESOURCEMove one WorkDrive file or folder to a different parent folder within an allowed space.

Input Parameters

string
required
WorkDrive file or folder ID to move.
string
required
Destination parent folder ID. Zoho rejects moves across incompatible spaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTI_DOWNLOADStart WorkDrive ZIP packaging for multiple resources and return the provider’s tracking metadata; this action does not return ZIP bytes.

Input Parameters

string
required
Comma-separated IDs of WorkDrive files or folders to package for download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTIPLE_COPYCopy multiple WorkDrive files or folders into one destination folder.

Input Parameters

array
required
IDs of the files or folders to copy.
string
required
ID of the destination folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTIPLE_DELETEPermanently delete one or more WorkDrive resources that are in Trash.

Input Parameters

array
required
Unique IDs of trashed files or folders to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTIPLE_MOVEMove one or more WorkDrive files or folders to one destination folder.

Input Parameters

array
required
Unique IDs of the files or folders to move.
string
required
Unique ID of the destination folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTIPLE_RESTORERestore one or more WorkDrive files or folders from Trash.

Input Parameters

array
required
Unique IDs of the trashed files or folders to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_MULTIPLE_TRASHMove one or more WorkDrive files or folders to Trash.

Input Parameters

array
required
Unique IDs of the files or folders to move to Trash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_PERFORM_TRANSITION_FOR_A_WORKFLOW_INSTANCEPerform a valid transition for a workflow instance, supplying any configured mandatory during-action values.

Input Parameters

string
required
Unique ID of the workflow instance to advance.
string
required
Transition ID exposed by the workflow instance and valid for its current state.
array
Values for configured during-actions. Omit when this transition has none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_PIN_TEAM_FOLDERPin a WorkDrive team folder for quick access.

Input Parameters

string
required
Unique ID of the team folder to pin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_FAVORITE_MULTIPLERemove one or more WorkDrive files or folders from favorites.

Input Parameters

array
required
Unique IDs of the files or folders to remove from favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_FILE_FAVORITERemove one WorkDrive file or folder from favorites.

Input Parameters

string
required
Unique ID of the WorkDrive file or folder to remove from favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_FINALRe-enable editing on a WorkDrive file that was marked as final.

Input Parameters

string
required
Unique ID of the final WorkDrive file to make editable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_FOLDER_CUSTOMIZATIONRemove custom attributes and settings from a WorkDrive folder.

Input Parameters

string
required
Unique ID of the customized WorkDrive folder to reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_RESOURCE_ACCESSRevoke one collaborator permission from a WorkDrive file or folder without deleting the resource. A 404 response is also reported as access removed.

Input Parameters

string
required
Collaboration permission ID returned by Share Resource or List Resource Collaborators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_RESOURCE_LABELSRemove a WorkDrive label from a file or folder after exact-ID confirmation.

Input Parameters

string
required
Unique ID of the label.
string
required
Unique ID of the file or folder to unlabel.
string
required
Repeat resource_id exactly to confirm removal of the label relationship.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REMOVE_TEMPLATE_CATEGORYRemoves a specified template file from a template category after exact-ID confirmation.

Input Parameters

string
required
Template category ID from which to remove the template.
string
required
Unique template file ID to remove from the category.
string
required
Repeat template_id exactly to confirm removal from the category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_DATA_TEMPLATERename an existing data template.

Input Parameters

string
required
New name for the data template.
string
required
Unique ID of the data template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_GROUPChange the name of an existing WorkDrive group.

Input Parameters

string
required
New name of the group.
string
required
Unique ID of the group to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_LABELChange only the name of an existing WorkDrive label.

Input Parameters

string
required
New label name.
string
required
Unique ID of the label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_RESOURCERename one WorkDrive file or folder without moving it.

Input Parameters

string
required
Replacement name for the file or folder.
string
required
WorkDrive file or folder ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_TEAMChange the display name of a WorkDrive team. The connected user must be a team administrator.

Input Parameters

string
required
New display name for the team.
string
required
Unique ID of the WorkDrive team to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RENAME_TEMPLATE_CATEGORYRenames the specified template category.

Input Parameters

string
required
The template category ID to rename.
string
required
The new name of the template category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_REOPEN_COMMENTReopen a previously resolved parent WorkDrive comment thread.

Input Parameters

string
required
Unique ID of the resolved parent comment to reopen.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RESOLVE_COMMENTMark a parent WorkDrive comment thread as resolved.

Input Parameters

string
required
Unique ID of the parent comment to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RESTORE_RESOURCERestore one trashed WorkDrive file or folder to its original location.

Input Parameters

string
required
Trashed WorkDrive file or folder ID to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_RESTORE_TO_VERSIONRestore one historical WorkDrive file version as the latest top version. This changes the file’s current content but preserves its version history.

Input Parameters

string
required
Exact historical version number to restore as the new top version, such as 5.0.
string
required
Unique ID of the WorkDrive file whose top version will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SAVE_RESOURCE_AS_TEMPLATESave a Zoho-format WorkDrive file as a reusable template in a template library.

Input Parameters

string
required
Name for the newly saved template.
string
required
ID of the My Templates, Org Templates, or Public Templates library in which to save the template.
string
required
ID of the Zoho-format file to save as a template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SEARCH_DATA_TEMPLATESearch one WorkDrive team for files and folders associated with a data template using a required text query, optionally narrowing by typed custom-field criteria.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; a leading minus requests descending order.
string ("all" | "name" | "content")
Where the text query must match: name and content, name only, or content only.
string
required
Text to search for in resource names, contents, or both.
string
Restrict the search to trashed resources.
string
required
Unique ID of the WorkDrive team to search.
integer
Maximum resources to return in this page (1-50).
integer
Optional end time as Unix milliseconds; provide with from_time_ms instead of date_filter.
string ("today" | "yesterday" | "last_week" | "last_30_days")
Optional predefined modification-date window.
integer
Zero-based result offset for this page.
string
Only return resources created by this Zoho user ID.
integer
Optional start time as Unix milliseconds; provide with to_time_ms instead of date_filter.
array
Structured custom-field criteria. They are encoded as one JSON query value for WorkDrive.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Optional resource type to include.
string
required
Data template ID. When a template response ID contains a colon, use the segment after the colon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SEARCH_RESOURCESSearch file names or contents across a team, My Folders, one team folder, one folder, or items shared with a user.

Input Parameters

string ("name" | "kind" | "shared_time" | "last_modified" | "created_time" | "-name" | "-kind" | "-shared_time" | "-last_modified" | "-created_time")
Sort field; a leading minus requests descending order.
string ("all" | "name" | "content")
Where the query must match: name and content, name only, or content only.
string
required
Text to search for in file names, contents, or both.
string
Restrict results to trashed resources; this is the status value consistently documented across official contracts.
string
required
WorkDrive team ID whose search index should be queried.
string ("team" | "my_folders" | "team_folder" | "folder" | "shared_with_me")
Search boundary within the team.
integer
Maximum matches to return in this page (1-50).
integer
Optional end time as Unix milliseconds; use with from_time_ms instead of date_filter.
string ("today" | "yesterday" | "last_week" | "last_30_days")
Optional predefined modification-date window.
string
Team-folder ID, folder ID, or user ZUID for the selected location. Required for every location except team.
integer
Zero-based result offset for the page.
string
Only return resources created by this Zoho user ID.
integer
Optional start time as Unix milliseconds; use with to_time_ms instead of date_filter.
string ("all" | "allfiles" | "documents" | "spreadsheets" | "presentations" | "pdf" | "audio" | "video" | "images" | "folder" | "mydrafts" | "documents_native" | "spreadsheets_native" | "presentations_native" | "documents_non_native" | "spreadsheets_non_native" | "presentations_non_native")
Resource type to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_EVERY_ONECreate persistent public view access to a WorkDrive file or folder for anyone on the internet. This broad exposure remains until the permission is revoked.

Input Parameters

string
required
WorkDrive file or folder ID to expose publicly.
string ("file" | "folder")
required
Whether resource_id is a file or folder; files use role 34 and folders use role 6.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_GROUP_MEMBERGrant every member of one WorkDrive group access to a file or folder. Group membership changes can alter the effective audience while this permission remains active.

Input Parameters

integer
required
Provider role ID to grant to every member of the selected group.
string
required
WorkDrive group ID whose members will receive access.
string
required
WorkDrive file or folder ID to share.
string
Optional group-share expiration in yyyy-mm-dd hh:mm:ss 24-hour format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_GROUPS_TEAM_FOLDERAdd one WorkDrive group to a team folder with a selected access role.

Input Parameters

integer ("1" | "2" | "5" | "6" | "34")
required
Team-folder role: 1 admin, 2 organizer, 5 editor, 6 commenter, or 34 viewer.
string
required
Unique ID of the WorkDrive group to add.
string
required
Unique ID of the team folder receiving the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_RESOURCEGrant one person access to a WorkDrive file or folder. Zoho sends an irreversible notification email by default unless send_notification_email is false; organization policy may allow an external recipient.

Input Parameters

string
required
Recipient email address. Team policy controls whether external recipients are allowed.
string ("viewer" | "editor" | "sharer" | "commenter" | "filler" | "organizer" | "uploader")
required
Access to grant. Files support viewer, editor, sharer, commenter, or filler; folders support viewer, editor, organizer, or uploader.
string
required
WorkDrive file or folder ID to share.
string ("file" | "folder")
required
Whether resource_id identifies a file or folder; this determines valid access levels.
string
Optional access expiry in yyyy-mm-dd hh:mm:ss format using 24-hour time.
boolean
Whether Zoho should email the recipient about the new access. Defaults to true; set false to avoid sending an irreversible notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_TEAMGrant every member of the WorkDrive team a selected role on one team folder. This is broad organization-wide exposure and remains active until revoked.

Input Parameters

integer ("1" | "2" | "5" | "6" | "34")
required
Role for every team member: 1 admin, 2 organizer, 5 editor, 6 commenter, or 34 viewer.
string
required
Unique team folder ID to share with the entire team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SHARE_TEAM_FOLDERAdd one WorkDrive user to a team folder with a selected access role.

Input Parameters

integer ("1" | "2" | "5" | "6" | "34")
required
Team-folder role: 1 admin, 2 organizer, 5 editor, 6 commenter, or 34 viewer.
string
required
Email address of the WorkDrive user to add.
string
required
Unique ID of the team folder receiving the member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_START_WORKFLOW_FOR_A_FILE_FOLDERStart an active workflow on a WorkDrive file or folder, including configured initial during-action values.

Input Parameters

string
required
Unique ID of the file or folder on which to start the workflow.
string
required
ID of the active workflow definition to start.
array
Values for configured initial-transition during-actions. Omit when the start transition has none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_SUSPEND_USERTemporarily suspend a WorkDrive team member. Access to the team and synced files is lost immediately, created content remains active, and the user license is canceled for reuse or reimbursement. Reactivation restores access. The official API does not document sending a notification.

Input Parameters

string
required
Team-member ID to suspend, in the provider’s {team-id}-{member-id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_TRASH_RESOURCEMove one WorkDrive file or folder to Trash. An already-trashed resource is reported as a successful idempotent outcome.

Input Parameters

string
required
WorkDrive file or folder ID to move to Trash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UN_ARCHIVE_TEAM_FOLDERReactivate an archived team folder with its data, roles, and sharing intact.

Input Parameters

string
required
Unique ID of the archived team folder to reactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UNFOLLOW_RESOURCESStop following one or more WorkDrive files or folders.

Input Parameters

array
required
Unique IDs of the files or folders to unfollow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UNLOCK_RESOURCECheck in a WorkDrive file so team members can edit and view changes.

Input Parameters

string
required
Unique ID of the checked-out WorkDrive file to check in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UN_MARK_INDEX_LAYOUT_FILERemove a WorkDrive Writer file as its folder’s Index View.

Input Parameters

string
required
Unique ID of the WorkDrive file to remove from its folder’s Index View.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UNPIN_TEAM_FOLDERRemove a team folder from the connected user’s pinned team-folder list.

Input Parameters

string
required
Unique ID of the team folder to unpin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UN_ZIP_FILEExtract all content from a WorkDrive ZIP file into a destination folder without merging names.

Input Parameters

string
required
ID of the WorkDrive ZIP file to extract.
string
required
ID of the destination folder for extracted content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_COLLECTION_SETTINGSUpdate the name, expiration, upload limit, or uploader-folder behavior of an active collection.

Input Parameters

string
required
Unique ID of the collection to update.
string
New collection name.
string
New expiration in YYYY-MM-dd or YYYY-MM-dd HH:mm format, or never.
boolean
Whether WorkDrive creates a separate folder for each uploader.
integer
Maximum files each uploader may submit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_CUSTOM_FIELDUpdate an existing custom field’s name, required flag, or choices.

Input Parameters

array
Choice add, update, or delete operations.
string
Updated custom field display name.
string
required
Unique ID of the custom field.
object
Type-specific properties to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_DESCRIPTIONChange or clear a WorkDrive team’s description. The connected user must be a team administrator.

Input Parameters

string
required
Unique ID of the WorkDrive team to update.
string
required
New team description. Pass an empty string to clear the description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_EXPIRATIONChange when an existing WorkDrive file or folder collaboration expires. Omitting expiration_date leaves that access active without a documented expiry.

Input Parameters

string
required
Collaboration permission ID whose expiration will change.
string
New expiration in yyyy-mm-dd or yyyy-mm-dd hh:mm[:ss] 24-hour format. Omit to leave the share active without an expiration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_GROUP_DESCRIPTIONUpdate the description of an existing WorkDrive group.

Input Parameters

string
required
Unique ID of the group to update.
string
required
New description of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_LIBRARY_USER_VIEW_PREFERENCEUpdate the connected user’s sort, filter, or layout preference for a template library.

Input Parameters

string
Layout used to display the template listing, such as grid.
string
Field by which to sort templates, such as created_time.
string
required
Template library ID for My Templates, Org Templates, or Public Templates.
string
Sort direction for the selected field, such as asc or desc.
string
Filter applied to the template listing, such as all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_MEMBER_ROLEChange an existing WorkDrive group member to Group Admin or Group Member.

Input Parameters

integer ("30" | "31")
required
New group role: 30 for Group Admin or 31 for Group Member.
string
required
Unique ID of the group membership to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_ORG_TEMPLATE_ADMIN_ROLEAssign or remove organization template-admin privileges for a WorkDrive team member.

Input Parameters

string
required
Team-member ID in the provider’s {team-id}-{member-id} form.
boolean
required
True assigns the organization template-admin role; false removes it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_PERMISSIONReplace the role on one existing WorkDrive collaboration. This can broaden the recipient’s access; Zoho rejects roles above the connected user’s authority.

Input Parameters

integer
required
Provider role ID to grant. Valid roles depend on the underlying resource and the caller’s own permission; use collaboration details to choose it.
string
required
Collaboration permission ID whose role will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_TEAM_FOLDER_DESCChange the description of an existing WorkDrive team folder.

Input Parameters

string
required
New description for the team folder.
string
required
Unique ID of the team folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_TEAM_FOLDER_MEMBERChange the access role of one existing WorkDrive team-folder membership.

Input Parameters

integer ("1" | "2" | "5" | "6" | "34")
required
New team-folder role: 1 admin, 2 organizer, 5 editor, 6 commenter, or 34 viewer.
string
required
Unique ID of the team-folder membership to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_TEAM_FOLDER_NAMEChange the name of an existing WorkDrive team folder.

Input Parameters

string
required
New name for the team folder.
string
required
Unique ID of the team folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_TEMPLATE_CATEGORYAssociate one Zoho-format template file with a template category.

Input Parameters

string
required
ID of the template category to update.
string
required
ID of the Zoho-format template file to associate with the category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_USER_ROLEChange a WorkDrive team member’s permissions to Member, Admin, or Super Admin. Super Admin grants the highest team authority and a team can have only one. The official API does not document sending a notification.

Input Parameters

integer ("30" | "31" | "32")
required
New role: 30 Member, 31 Admin, or 32 Super Admin.
string
required
Team-member ID to update, in the provider’s {team-id}-{member-id} form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPDATE_VALUES_OF_ASSOCIATED_FILES_FOLDERSReplace custom field values on an existing data-template association.

Input Parameters

array
required
Custom field IDs and their replacement values.
string
required
Unique ID of the file/folder and template association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPLOAD_FILEUpload actual file content to a WorkDrive folder using the provider’s multipart endpoint.

Input Parameters

object
required
File content to upload; WorkDrive accepts files up to 250 MB on this endpoint.
string
Optional UTF-8 URL-encoded filename, including its extension.
string
required
ID of the WorkDrive folder that will contain the file.
string ("true" | "false")
Use true to upload as a new top version of a same-name file, or false to make WorkDrive add a timestamp to the new name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPLOAD_FILE_CHUNKUpload one sequential chunk to an existing WorkDrive upload session through the connection’s regional stream endpoint.

Input Parameters

object
required
One sequential chunk whose bytes become the request body.
string
required
Upload ID returned by Create Session.
string
required
Exact chunk range in the form bytes start-end/total.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPLOAD_LARGE_FILEUpload a file through WorkDrive’s regional stream endpoint for files larger than 250 MB.

Input Parameters

object
required
Large file whose bytes become the stream-upload request body.
string
required
Filename including extension; the action URL-encodes it as UTF-8.
string
required
ID of the destination WorkDrive folder.
string
required
Unique upload processing ID.
boolean
True to create a top version of a same-name file; false to let WorkDrive timestamp-rename it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPLOAD_NEW_VERSIONUpload replacement content as the top version of an existing WorkDrive file. The existing file is selected by its containing folder and matching filename; the operation always enables WorkDrive’s overwrite-as-version behavior.

Input Parameters

object
required
Replacement file content to upload as the top version. Maximum documented size is 250 MB.
string
Existing filename to replace. Omit to use the uploaded file’s name.
string
required
ID of the folder containing the existing WorkDrive file.
string
Version-upload mode required by WorkDrive. Only true is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_UPLOAD_STATUSCheck the progress or error state of a WorkDrive stream upload.

Input Parameters

string
required
Upload progress ID returned by the WorkDrive stream upload operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_WORK_DRIVE_ZIP_PROGRESS_FILEFetch ZIP creation progress using the WMS progress key.

Input Parameters

string
required
ZIP progress ID returned by the create-ZIP operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not