Mark File as Final
The Mark as Final feature in WorkDrive helps you indicate that a file has reached its completed or approved state. Once marked as final, the file becomes read-only and cannot be edited until editing is re-enabled.
Learn more about the Mark as Final feature
Note:
Only users with edit permission can mark or unmark a file as final.
This API allows you to mark a file as final in WorkDrive. Once a file is marked as final, it becomes read-only and cannot be edited until editing is re-enabled.
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":{"is_marked_final":true},"type":"files"}}'Path Parameters
resource_idstring(Required)
The unique ID of the file to be marked as final.
Request Body
application/vnd.api+jsondataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
is_marked_finalboolean(Required)
Set this attribute to true to mark the file as final.
typestring(Required)
The JSON:API resource type. Always "files".
Allowed Values :
Show Values ▾
filesCopied!
Copy all as JSON Array
{
"data": {
"attributes": {
"is_marked_final": true
},
"type": "files"
}
}
{
"data": {
"id": "p8pts15b26642e0be41e6a9953d102a7416d7",
"type": "files",
"attributes": {
"active_workflow_instance": {},
"modified_by_zuid": "56564640",
"is_locked": false,
"conv_engine_type": 0,
"dlp_info": {
"dlp_meta_info": [],
"dlp_top_level_actions": {
"can_restrict_download": false,
"can_restrict_share": false,
"can_warn_on_share": false
}
},
"is_fillable_resource": false,
"is_published": false,
"destination_id": "jurc876ee478b238e45e6a8e06f6b58b87e0d",
"storage_info": {
"size": "63 bytes",
"storage_used": "164 bytes",
"files_count": 0,
"folders_count": 0,
"size_in_bytes": 63,
"storage_used_in_bytes": 164,
"storage_used_by_team_folders_in_bytes": 0,
"size_used_by_team_folders_in_bytes": 0,
"storage_used_by_workdrive_in_bytes": 0,
"storage_used_by_app_in_bytes": 0
},
"type": "bookmark",
"spam_info": {
"is_cur_res_spam": false,
"is_par_res_spam": false
},
"created_time_i18": "May 28, 11:06 PM",
"associated_data_templates": [],
"is_marked_final": true,
"modified_time_in_millisecond": 1748454898476,
"opened_time": "May 28, 11:24 PM",
"status_change_time": "May 28, 11:24 PM",
"role_id": 1,
"download_url": "https://download-accl.zoho.com/v1/workdrive/download/p8pts15b26642e0be41e6a9953d102a7416d7",
"comment_badge_count": 0,
"is_app_associated": false,
"created_time": "May 28, 11:06 PM",
"lock_status": 2,
"is_folder": false,
"is_parent_customized": false,
"resource_type": 2520,
"is_email_in_upload": false,
"res_scope": 0,
"display_attr_name": "WorkDrive.url",
"user_access_time": "May 28, 11:24 PM",
"created_by": "Zylker Creation",
"display_html_name": "WorkDrive.url",
"labels": [],
"user_access_time_i18": "May 28, 11:24 PM",
"org_id": "4fv34c66f6999f0fb43f182eabf70e5947b6f",
"parent_id": "jurc876ee478b238e45e6a8e06f6b58b87e0d",
"name": "WorkDrive.url",
"status_change_time_in_millisecond": 1748454898476,
"permalink": "https://www.zohoapis.com/workdrive/file/p8pts15b26642e0be41e6a9953d102a7416d7",
"favorite": false,
"new_badge_count": 0,
"status": 1,
"modified_time_i18": "May 28, 11:24 PM",
"opened_time_i18": "May 28, 11:24 PM",
"extn": "url",
"customized": false,
"user_access_time_in_millis": 1748454898542,
"shortcut_link": "https://workdrive.zoho.com",
"url_link": "https://workdrive.zoho.com",
"status_change_time_i18": "May 28, 11:24 PM",
"description": "",
"uploaded_time_in_millisecond": 1748453772456,
"thumbnail_url": "https://previewengine-accl.zoho.com/thumbnail/WD/p8pts15b26642e0be41e6a9953d102a7416d7",
"title": "",
"modified_time": "May 28, 11:24 PM",
"library_id": "pqh57e15714708a9549b4a732866ac4b7e938",
"icon_class": "domain",
"created_time_in_millisecond": 1748453772443,
"owner": "54409116",
"creator": "56564640",
"capabilities": {
"can_read": true,
"can_share": false,
"can_remove_share": false,
"can_delete": false,
"can_edit": false,
"can_partial_read": false,
"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": false,
"can_create_task": true,
"can_share_support": false,
"can_label": true,
"can_delist_file": false,
"can_associate_data_template": true,
"can_favorite": true,
"can_customize": false,
"can_configure_workflow": true,
"is_edit_restricted_via_workflow": false,
"can_show_activity": true,
"can_show_access_stats": true,
"can_checkout": false,
"can_cancel_checkout": false,
"can_discard_checkout": false,
"can_checkin": false,
"can_read_comment": true,
"can_create_comment": true,
"can_mark_as_final": true,
"can_trash_files": true,
"can_open_with_addons": false,
"has_app_permission_alone": false
},
"uploaded_time_i18": "May 28, 11:06 PM",
"is_external_upload": false,
"watch_preference": {
"watch": false,
"notifyemail": false,
"notifybell": false
},
"opened_time_in_millisecond": 1748454898542,
"edit_badge_count": 0,
"share_data": [],
"data_template_id_to_mandate": "",
"uploaded_time": "May 28, 11:06 PM",
"has_folders": false,
"service_type": "upload",
"display_url_name": "WorkDrive.url",
"is_unread": false,
"modified_by": "Zylker Creation",
"is_index_layout_file": false,
"embed_props": {}
},
"relationships": {
"folders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/folders",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/folders"
}
},
"filequery": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/filequery",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/filequery"
}
},
"dlpsensitivecontentidentifiers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/dlpsensitivecontentidentifiers",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/dlpsensitivecontentidentifiers"
}
},
"records": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/records",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/records"
}
},
"instances": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/instances",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/instances"
}
},
"unzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/unzip",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/unzip"
}
},
"performtransition": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/performtransition",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/performtransition"
}
},
"accesschartdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/accesschartdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/accesschartdata"
}
},
"resourceproperty": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/resourceproperty",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/resourceproperty"
}
},
"shortcut": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/shortcut",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/shortcut"
}
},
"linkfile": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/linkfile",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/linkfile"
}
},
"importfile": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/importfile",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/importfile"
}
},
"permissions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/permissions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/permissions"
}
},
"saveastemplate": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/saveastemplate",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/saveastemplate"
}
},
"links": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/links",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/links"
}
},
"copy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/copy",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/copy"
}
},
"previewzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/previewzip",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/previewzip"
}
},
"tasks": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/tasks",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/tasks"
}
},
"custommetadata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/custommetadata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/custommetadata"
}
},
"deletedversions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/deletedversions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/deletedversions"
}
},
"comments": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/comments",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/comments"
}
},
"previewinfo": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/previewinfo",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/previewinfo"
}
},
"approvedversions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/approvedversions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/approvedversions"
}
},
"publiclink": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/publiclink",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/publiclink"
}
},
"parentfolders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/parentfolders",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/parentfolders"
}
},
"versions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/versions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/versions"
}
},
"supportshare": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/supportshare",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/supportshare"
}
},
"startjourney": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/startjourney",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/startjourney"
}
},
"recordsuggestions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/recordsuggestions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/recordsuggestions"
}
},
"timeline": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/timeline",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/timeline"
}
},
"files": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/files",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/files"
}
},
"accessdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/accessdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/accessdata"
}
},
"dlppolicy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/dlppolicy",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/dlppolicy"
}
},
"breadcrumbs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/breadcrumbs",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/breadcrumbs"
}
},
"entity": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/entity",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/entity"
}
},
"statistics": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/statistics",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/statistics"
}
},
"appdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/relationships/appdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7/appdata"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/p8pts15b26642e0be41e6a9953d102a7416d7"
}
}
}
{
"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.