Check in File
This API will check in the file, which will allow other team members to edit the file and see the changes being made in the file.
Endpoints
OAuth Scope
WorkDrive.files.UPDATECopied!
curl --request PATCH \
--url https://www.zohoapis.com/workdrive/api/v1/files/{resource_id} \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/vnd.api+json' \
--data '{"data":{"attributes":{"lock_status":"2"},"type":"files"}}'Path Parameters
resource_idstring(Required)
The unique ID of the file/folder.
Request Body
application/vnd.api+jsondataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
lock_statusinteger(Required)
Allowed value of unlock status:
typestring(Required)
The JSON:API resource type. Always "files".
Allowed Values :
Show Values ▾
filesCopied!
Copy all as JSON Array
{
"data": {
"attributes": {
"lock_status": "2"
},
"type": "files"
}
}
{
"data": {
"id": "ly9zm6bfb474b23d945288fd11f123c05843e",
"type": "files",
"attributes": {
"modified_by_zuid": "747938014",
"is_locked": false,
"conv_engine_type": 0,
"is_fillable_resource": false,
"is_published": false,
"collab_id": "2243193149594280833",
"destination_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
"storage_info": {
"size": "0 bytes",
"storage_used": "0 bytes",
"files_count": 0,
"folders_count": 0,
"size_in_bytes": 0,
"storage_used_in_bytes": 0
},
"type": "writer",
"created_time_i18": "Apr 13, 12:07 AM",
"modified_time_in_millisecond": 1618252672046,
"opened_time": "Apr 13, 12:07 AM",
"status_change_time": "Apr 13, 12:07 AM",
"download_url": "https://download-accl.zoho.com/v1/workdrive/download/ly9zm6bfb474b23d945288fd11f123c05843e",
"comment_badge_count": 0,
"is_app_associated": false,
"created_time": "Apr 13, 12:07 AM",
"lock_status": 2,
"is_folder": false,
"resource_type": 2001,
"is_email_in_upload": false,
"display_attr_name": "Report April Month",
"user_access_time": "Apr 13, 12:07 AM",
"created_by": "Zylker Creation",
"display_html_name": "Report April Month",
"labels": [],
"user_access_time_i18": "Apr 13, 12:07 AM",
"org_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
"parent_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
"name": "Report April Month",
"status_change_time_in_millisecond": 1618252672046,
"permalink": "https://writer.zoho.com/writer/open/ly9zm6bfb474b23d945288fd11f123c05843e",
"favorite": false,
"new_badge_count": 0,
"status": 1,
"modified_time_i18": "Apr 13, 12:07 AM",
"opened_time_i18": "Apr 13, 12:07 AM",
"extn": "zwriter",
"user_access_time_in_millis": 1618252672046,
"shortcut_link": "",
"status_change_time_i18": "Apr 13, 12:07 AM",
"description": "",
"uploaded_time_in_millisecond": 1618252658914,
"thumbnail_url": "https://previewengine-accl.zoho.com/thumbnail/WD/ly9zm6bfb474b23d945288fd11f123c05843e",
"title": "",
"modified_time": "Apr 13, 12:07 AM",
"library_id": "ly9zm0170fb40015f4e2297a144e2b68cfa68",
"icon_class": "writer",
"created_time_in_millisecond": 1618252658911,
"owner": "747937818",
"creator": "747938014",
"capabilities": {
"can_read": true,
"can_share": true,
"can_remove_share": false,
"can_delete": false,
"can_edit": true,
"can_upload_files": true,
"can_trash": true,
"can_rename": true,
"can_restore": false,
"can_copy": true,
"can_move": true,
"can_zip": true,
"can_download": true,
"can_emailattach": true,
"can_publish": true,
"can_create_task": true,
"can_share_support": true,
"can_label": true,
"can_checkout": true,
"can_cancel_checkout": false,
"can_discard_checkout": false,
"can_checkin": false,
"can_read_comment": true,
"can_create_comment": true,
"can_trash_files": true
},
"uploaded_time_i18": "Apr 13, 12:07 AM",
"is_external_upload": false,
"watch_preference": {
"watch": false,
"notifyemail": false,
"notifybell": false
},
"opened_time_in_millisecond": 1618252658911,
"edit_badge_count": 0,
"share_data": [],
"data_template_id_to_mandate": "",
"uploaded_time": "Apr 13, 12:07 AM",
"has_folders": false,
"service_type": "zw",
"recent_action": "last_modified_time",
"display_url_name": "Report+April+Month",
"is_unread": false,
"modified_by": "Zylker Creation",
"embed_props": {}
},
"relationships": {
"folders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/folders",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/folders"
}
},
"comments": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/comments",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/comments"
}
},
"previewinfo": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewinfo",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewinfo"
}
},
"unzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/unzip",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/unzip"
}
},
"publiclink": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/publiclink",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/publiclink"
}
},
"resourceproperty": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/resourceproperty",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/resourceproperty"
}
},
"parentfolders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/parentfolders",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/parentfolders"
}
},
"shortcut": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/shortcut",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/shortcut"
}
},
"importfile": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/importfile",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/importfile"
}
},
"versions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/versions",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/versions"
}
},
"supportshare": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/supportshare",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/supportshare"
}
},
"permissions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/permissions",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/permissions"
}
},
"timeline": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/timeline",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/timeline"
}
},
"files": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/files",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/files"
}
},
"saveastemplate": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/saveastemplate",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/saveastemplate"
}
},
"links": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/links",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/links"
}
},
"copy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/copy",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/copy"
}
},
"previewzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/previewzip",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/previewzip"
}
},
"tasks": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/tasks",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/tasks"
}
},
"breadcrumbs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/breadcrumbs",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/breadcrumbs"
}
},
"entity": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/entity",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/entity"
}
},
"custommetadata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/custommetadata",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/custommetadata"
}
},
"statistics": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/statistics",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/statistics"
}
},
"appdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/relationships/appdata",
"related": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e/appdata"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/files/ly9zm6bfb474b23d945288fd11f123c05843e"
}
}
}
{
"errors": [
{
"id": "R1304",
"title": "The resourceId must be a writer file type"
}
]
}
{
"errors": [
{
"id": "R105",
"title": "Error while restoring files"
}
]
}
{
"errors": [
{
"id": "R004",
"title": "Invalid resourceId"
}
]
}
{
"errors": [
{
"id": "R002",
"title": "Folder with same name exists in the workspace. Please use a different name"
}
]
}
{
"errors": [
{
"id": "R101",
"title": "File trash in progress. Try Later"
}
]
}
{
"errors": [
{
"id": "R102",
"title": "Files restore in progress. Try later"
}
]
}
{
"errors": [
{
"id": "R023",
"title": "Invalid name"
}
]
}
{
"errors": [
{
"id": "R507",
"title": "Copy action processing for this resource. So cannot copy or move this resource."
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
{
"errors": [
{
"id": "F7003",
"title": "Invalid OAuth token"
}
]
}
{
"errors": [
{
"id": "A014",
"title": "API not enabled for this file type"
}
]
}
{
"errors": [
{
"id": "R508",
"title": "Move out of the defined scope is not allowed for the user."
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Insufficient permissions"
}
]
}
{
"errors": [
{
"id": "T031",
"title": "Team is integrated with other app or bundle"
}
]
}
{
"errors": [
{
"id": "R1300",
"title": "Permanent Delete not possible as Data on Hold"
}
]
}
{
"errors": [
{
"id": "R004",
"title": "Invalid resourceId passed"
}
]
}
{
"errors": [
{
"id": "T001",
"title": "No Such Team"
}
]
}
{
"errors": [
{
"id": "R102",
"title": "Files restore in progress. Try later"
}
]
}
{
"errors": [
{
"id": "R1303",
"title": "The Index layout file is already mapped to the parent"
}
]
}
{
"errors": [
{
"id": "R961",
"title": "Marking file as final action failed"
}
]
}
{
"errors": [
{
"id": "R271",
"title": "Trash action processing for this resource. So, you cannot restore this resource."
}
]
}
{
"errors": [
{
"id": "R402",
"title": "Document is not locked yet"
}
]
}
{
"errors": [
{
"id": "R403",
"title": "This resource cannot be locked"
}
]
}
{
"errors": [
{
"id": "R103",
"title": "Error while trash files"
}
]
}
{
"errors": [
{
"id": "R400",
"title": "File has been locked already"
}
]
}
{
"errors": [
{
"id": "R104",
"title": "Error while delete files"
}
]
}
{
"errors": [
{
"id": "R401",
"title": "You are not authorized to unlock the file"
}
]
}
{
"errors": [
{
"id": "F283",
"title": "Folder is getting copied and cannot trash the resource"
}
]
}
{
"errors": [
{
"id": "V006",
"title": "Can't checkout subversion"
}
]
}
{
"errors": [
{
"id": "R509",
"title": "Source and destination cannot be the same while move."
}
]
}
{
"errors": [
{
"id": "F000",
"title": "General exception"
}
]
}
{
"errors": [
{
"id": "F221",
"title": "Resource has been Trashed already"
}
]
}
{
"errors": [
{
"id": "F268",
"title": "Copy action processing for this resource. So, you cannot trash this resource."
}
]
}
{
"errors": [
{
"id": "R012",
"title": "Resource is not in active status to process this action"
}
]
}
{
"errors": [
{
"id": "Z010",
"title": "Myfolder Storage limit exceeds"
}
]
}
{
"errors": [
{
"id": "Z011",
"title": "Storage limit exceeds"
}
]
}
{
"errors": [
{
"id": "R514",
"title": "Moving resource across space not allowed."
}
]
}
{
"errors": [
{
"id": "R217",
"title": "Error while add favorite"
}
]
}
{
"errors": [
{
"id": "R515",
"title": "My Space storage limit exceeded, cannot move resource into my folder."
}
]
}
{
"errors": [
{
"id": "R218",
"title": "Error while remove favorite"
}
]
}
{
"errors": [
{
"id": "R513",
"title": "Move not Allowed As Data on Hold."
}
]
}
{
"errors": [
{
"id": "R510",
"title": "User does not have permission to move this resource."
}
]
}
{
"errors": [
{
"id": "R213",
"title": "Invalid operation"
}
]
}
{
"errors": [
{
"id": "F210",
"title": "Invalid move operation destination or source is of invalid resource type."
}
]
}
{
"errors": [
{
"id": "F211",
"title": "Move resource is restricted for Zia Hub."
}
]
}
{
"errors": [
{
"id": "F277",
"title": "Trying to move a hidden resource type."
}
]
}
{
"errors": [
{
"id": "R516",
"title": "Move action failed as storage limit exceeded in the destination Team Folder."
}
]
}
{
"errors": [
{
"id": "F213",
"title": "Exception while restore resource."
}
]
}
{
"errors": [
{
"id": "F237",
"title": "Resource can't be moved into same resource or its sub resource."
}
]
}
{
"errors": [
{
"id": "F415",
"title": "Trash operation not allowed."
}
]
}
{
"errors": [
{
"id": "V005",
"title": "Invalid version info"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.