Convert File to Zoho Format

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API converts supported non-Zoho files into Zoho Office formats, such as Writer, Sheet, and Show.

Endpoints

OAuth Scope

WorkDrive.files.CREATECopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/importfile \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"name":"worksheet","resource_id":"d1mlj59afbbdf85bb4cd5b95f8177e4e805dc"},"type":"files"}}'

Path Parameters

resource_idstring(Required)

The unique ID of the destination folder.

Request Body

application/vnd.api+json
dataJSON Object(Required)
Hide Sub-Attributes
attributesJSON Object(Required)
Hide Sub-Attributes
namestring(Required)

The name of the file.

resource_idstring(Required)

The unique ID of the imported file.

typestring(Required)

The JSON:API resource type. Always "files".

Allowed Values :
Show Values
filesCopied!
Copied!Copy all as JSON Array

Body Parameters

Copied!
  {
    "data": {
      "attributes": {
        "name": "worksheet",
        "resource_id": "d1mlj59afbbdf85bb4cd5b95f8177e4e805dc"
      },
      "type": "files"
    }
  }
                
Show full

Response Example

R004

F7003

R008

R008

F7004

F6018

F6018

F000

F233

F202

200
200
400
401
403
500
Copied!
  {
    "data": [
      {
        "id": "d1mljabb238c99b7744a7b7f6259a2bf26390",
        "type": "files",
        "attributes": {
          "modified_by_zuid": "696039393",
          "is_locked": false,
          "conv_engine_type": 0,
          "is_fillable_resource": false,
          "is_published": false,
          "destination_id": "d1mljb8039f3ad8714c6aabcfd8df63dac7f8",
          "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": "zohosheet",
          "created_time_i18": "Sep 14, 12:34 PM",
          "modified_time_in_millisecond": 1631603092954,
          "opened_time": "Sep 14, 12:34 PM",
          "status_change_time": "Sep 14, 12:34 PM",
          "download_url": "https://download-accl.zoho.com/v1/workdrive/download/d1mljabb238c99b7744a7b7f6259a2bf26390",
          "comment_badge_count": 0,
          "is_app_associated": false,
          "created_time": "Sep 14, 12:34 PM",
          "lock_status": 2,
          "is_folder": false,
          "resource_type": 2101,
          "is_email_in_upload": false,
          "display_attr_name": "worksheet",
          "created_by": "Mohammed",
          "display_html_name": "worksheet",
          "labels": [],
          "org_id": "ge60277a7b25a570f4720b10d2f5f57cc83b0",
          "parent_id": "d1mljb8039f3ad8714c6aabcfd8df63dac7f8",
          "name": "worksheet",
          "status_change_time_in_millisecond": 1631603092954,
          "permalink": "https://sheet.zoho.com/sheet/open/d1mljabb238c99b7744a7b7f6259a2bf26390",
          "favorite": false,
          "new_badge_count": 0,
          "status": 1,
          "modified_time_i18": "Sep 14, 12:34 PM",
          "opened_time_i18": "Sep 14, 12:34 PM",
          "extn": "xlsx",
          "shortcut_link": "",
          "status_change_time_i18": "Sep 14, 12:34 PM",
          "description": "",
          "uploaded_time_in_millisecond": 1631603092542,
          "thumbnail_url": "https://previewengine-accl.zoho.com/thumbnail/WD/d1mljabb238c99b7744a7b7f6259a2bf26390",
          "title": "",
          "modified_time": "Sep 14, 12:34 PM",
          "library_id": "d1mljb8039f3ad8714c6aabcfd8df63dac7f8",
          "icon_class": "sheet",
          "created_time_in_millisecond": 1631603092542,
          "owner": "696070234",
          "creator": "696039393",
          "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_delist_file": false,
            "can_associate_data_template": true,
            "can_favorite": 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": "Sep 14, 12:34 PM",
          "is_external_upload": false,
          "watch_preference": {
            "watch": false,
            "notifyemail": false,
            "notifybell": false
          },
          "opened_time_in_millisecond": 1631603092542,
          "edit_badge_count": 0,
          "share_data": [],
          "data_template_id_to_mandate": "",
          "uploaded_time": "Sep 14, 12:34 PM",
          "has_folders": false,
          "service_type": "zohosheet",
          "display_url_name": "worksheet",
          "is_unread": false,
          "modified_by": "Mohammed",
          "embed_props": {}
        },
        "relationships": {
          "folders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/folders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/folders"
            }
          },
          "unzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/unzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/unzip"
            }
          },
          "accesschartdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/accesschartdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/accesschartdata"
            }
          },
          "resourceproperty": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/resourceproperty",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/resourceproperty"
            }
          },
          "shortcut": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/shortcut",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/shortcut"
            }
          },
          "importfile": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/importfile",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/importfile"
            }
          },
          "permissions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/permissions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/permissions"
            }
          },
          "saveastemplate": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/saveastemplate",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/saveastemplate"
            }
          },
          "links": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/links",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/links"
            }
          },
          "copy": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/copy",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/copy"
            }
          },
          "previewzip": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/previewzip",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/previewzip"
            }
          },
          "tasks": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/tasks",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/tasks"
            }
          },
          "custommetadata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/custommetadata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/custommetadata"
            }
          },
          "comments": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/comments",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/comments"
            }
          },
          "previewinfo": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/previewinfo",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/previewinfo"
            }
          },
          "publiclink": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/publiclink",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/publiclink"
            }
          },
          "parentfolders": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/parentfolders",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/parentfolders"
            }
          },
          "versions": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/versions",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/versions"
            }
          },
          "supportshare": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/supportshare",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/supportshare"
            }
          },
          "timeline": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/timeline",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/timeline"
            }
          },
          "files": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/files",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/files"
            }
          },
          "accessdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/accessdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/accessdata"
            }
          },
          "breadcrumbs": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/breadcrumbs",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/breadcrumbs"
            }
          },
          "entity": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/entity",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/entity"
            }
          },
          "statistics": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/statistics",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/statistics"
            }
          },
          "appdata": {
            "links": {
              "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/relationships/appdata",
              "related": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390/appdata"
            }
          }
        },
        "links": {
          "self": "https://www.zohoapis.com/workdrive/api/v1/files/d1mljabb238c99b7744a7b7f6259a2bf26390"
        }
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R004",
        "title": "Invalid resourceId"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F7003",
        "title": "Invalid OAuth token"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R008",
        "title": "Insufficient permissions"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F7004",
        "title": "Invalid OAuth scope"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F6018",
        "title": "File contains spamming content"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F000",
        "title": "General exception"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F233",
        "title": "Convert to native not possible for conversion failed resource"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F202",
        "title": "Resource details is empty"
      }
    ]
  }
                
Show full