Add a File to the Index View
The Index View in WorkDrive lets you present a structured summary of a folder using a Zoho Writer file. This file acts as a dynamic guide, helping users quickly discover important files, folders, and resources without browsing each item individually.
For instance, in a project folder, you can create an index on a Writer file with organized links to key resources such as Getting Started guides, essential steps, and troubleshooting tips. By setting this file as the Index for the folder, team members can instantly access important documents and navigate to relevant sections with ease.
Learn more about Index View.
Note:
Supported File Type for Index View: Zoho Writer file only.
Only one Writer file can be designated as the Index within a Folder or Team Folder.
Index View is supported only in My Folder and Team/Org Folder views.
Only users with Edit permission or higher can add or remove an Index view.
The Index file must be selected from the current folder. Files from other folders cannot be set as the Index.
If an Index file already exists, other Writer files in the folder cannot be marked as Index.
This API allows you to add an Index View to a folder by marking a Writer file as the Index.
Once added:
The selected file becomes the default Index View for the folder.
All users accessing the folder will see the Index View by default.
Note:
The immediate parent Folder or Team Folder will store the Index file reference using the index_layout_res_id property. This property contains the resource ID of the file set as the Index.
Endpoints
OAuth Scope
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_index_layout_file":true},"type":"files"}}'Path Parameters
The unique ID of the Writer file to be added as the Index view.
Request Body
application/vnd.api+jsonHide Sub-Attributes
Hide Sub-Attributes
Set this attribute to true to add the file as the Index view.
The JSON:API resource type. Always "files".
{
"data": {
"attributes": {
"is_index_layout_file": true
},
"type": "files"
}
}
{
"data": {
"id": "q44mn198a1342736f4a98bb6661e120e6c69b",
"type": "files",
"attributes": {
"active_workflow_instance": {},
"modified_by_zuid": "65817146",
"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,
"collab_id": "1207124650189624035",
"destination_id": "323a1f5e3f265b0b849f7ba297ff90126cf2a",
"storage_info": {
"size": "0 byte",
"storage_used": "0 byte",
"files_count": 0,
"folders_count": 0,
"size_in_bytes": 0,
"storage_used_in_bytes": 0,
"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": "writer",
"spam_info": {
"is_res_spam": false
},
"created_time_i18": "Aug 6, 2024, 4:06 PM",
"associated_data_templates": [],
"is_marked_final": false,
"modified_time_in_millisecond": 1722940582960,
"opened_time": "Dec 22, 8:13 PM",
"status_change_time": "Aug 6, 2024, 4:06 PM",
"role_id": 1,
"download_url": "https://download-accl.zoho.com/v1/workdrive/download/q44mn198a1342736f4a98bb6661e120e6c69b",
"comment_badge_count": 0,
"is_app_associated": false,
"created_time": "Aug 6, 2024, 4:06 PM",
"lock_status": 2,
"is_folder": false,
"is_parent_customized": false,
"resource_type": 2001,
"is_email_in_upload": false,
"res_scope": 0,
"display_attr_name": "Zylker Index view.",
"user_access_time": "Dec 22, 8:13 PM",
"created_by": "Zylker Creation",
"display_html_name": "Zylker Index view.",
"labels": [],
"user_access_time_i18": "Dec 22, 8:13 PM",
"org_id": "6oq3d00e1e07d58c64077b4f1c1f28da4a777",
"parent_id": "323a1f5e3f265b0b849f7ba297ff90126cf2a",
"name": "Zylker Index view.",
"status_change_time_in_millisecond": 1722940582960,
"permalink": "https://writer.zoho.com/writer/open/q44mn198a1342736f4a98bb6661e120e6c69b",
"favorite": false,
"new_badge_count": 0,
"status": 1,
"modified_time_i18": "Aug 6, 2024, 4:06 PM",
"opened_time_i18": "Dec 22, 8:13 PM",
"extn": "zwriter",
"customized": false,
"user_access_time_in_millis": 1766414630284,
"shortcut_link": "",
"status_change_time_i18": "Aug 6, 2024, 4:06 PM",
"description": "",
"uploaded_time_in_millisecond": 1722940569578,
"thumbnail_url": "https://previewengine-accl.zoho.com/thumbnail/WD/q44mn198a1342736f4a98bb6661e120e6c69b",
"title": "",
"modified_time": "Aug 6, 2024, 4:06 PM",
"library_id": "323a1f5e3f265b0b849f7ba297ff90126cf2a",
"icon_class": "writer",
"created_time_in_millisecond": 1722940569575,
"owner": "60040420614",
"creator": "65817146",
"url_link": "",
"capabilities": {
"can_read": true,
"can_share": true,
"can_remove_share": false,
"can_delete": false,
"can_edit": true,
"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": true,
"can_create_task": true,
"can_share_support": true,
"can_label": true,
"can_delist_file": false,
"can_associate_data_template": true,
"can_favorite": true,
"can_customize": false,
"can_configure_workflow": false,
"can_show_activity": true,
"can_show_access_stats": true,
"can_show_active_workflow_instance": false,
"can_checkout": true,
"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": "Aug 6, 2024, 4:06 PM",
"is_external_upload": false,
"watch_preference": {
"watch": false,
"notifyemail": false,
"notifybell": false
},
"opened_time_in_millisecond": 1766414630284,
"edit_badge_count": 0,
"share_data": [],
"data_template_id_to_mandate": "",
"uploaded_time": "Aug 6, 2024, 4:06 PM",
"has_folders": false,
"service_type": "zw",
"display_url_name": "Zylker Index view.",
"is_unread": false,
"modified_by": "Zylker Creation",
"creator_avatar_url": "https://contacts.zoho.com/file?t=user&ID=65817146&fs=thumb&nps=404",
"is_index_layout_file": true,
"embed_props": {}
},
"relationships": {
"linkfile": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/linkfile",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/linkfile"
}
},
"folders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/folders",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/folders"
}
},
"filequery": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/filequery",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/filequery"
}
},
"dlpsensitivecontentidentifiers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/dlpsensitivecontentidentifiers",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/dlpsensitivecontentidentifiers"
}
},
"records": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/records",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/records"
}
},
"instances": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/instances",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/instances"
}
},
"unzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/unzip",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/unzip"
}
},
"performtransition": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/performtransition",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/performtransition"
}
},
"accesschartdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/accesschartdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/accesschartdata"
}
},
"resourceproperty": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/resourceproperty",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/resourceproperty"
}
},
"shortcut": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/shortcut",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/shortcut"
}
},
"importfile": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/importfile",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/importfile"
}
},
"permissions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/permissions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/permissions"
}
},
"saveastemplate": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/saveastemplate",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/saveastemplate"
}
},
"links": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/links",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/links"
}
},
"copy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/copy",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/copy"
}
},
"previewzip": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/previewzip",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/previewzip"
}
},
"tasks": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/tasks",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/tasks"
}
},
"custommetadata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/custommetadata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/custommetadata"
}
},
"deletedversions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/deletedversions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/deletedversions"
}
},
"comments": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/comments",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/comments"
}
},
"previewinfo": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/previewinfo",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/previewinfo"
}
},
"approvedversions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/approvedversions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/approvedversions"
}
},
"publiclink": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/publiclink",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/publiclink"
}
},
"parentfolders": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/parentfolders",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/parentfolders"
}
},
"versions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/versions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/versions"
}
},
"supportshare": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/supportshare",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/supportshare"
}
},
"startjourney": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/startjourney",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/startjourney"
}
},
"recordsuggestions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/recordsuggestions",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/recordsuggestions"
}
},
"timeline": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/timeline",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/timeline"
}
},
"files": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/files",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/files"
}
},
"accessdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/accessdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/accessdata"
}
},
"dlppolicy": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/dlppolicy",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/dlppolicy"
}
},
"breadcrumbs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/breadcrumbs",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/breadcrumbs"
}
},
"entity": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/entity",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/entity"
}
},
"statistics": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/statistics",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/statistics"
}
},
"appdata": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/relationships/appdata",
"related": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b/appdata"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/files/q44mn198a1342736f4a98bb6661e120e6c69b"
}
}
}
{
"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.