Copy Document

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

Creates a copy of an existing document, optionally converting its format, copying a specific historical version, or overriding the resulting document's type.

Endpoints

OAuth Scope

ZohoWriter.documentEditor.ALLWorkDrive.files.ALLWorkDrive.organization.ALLWorkDrive.workspace.ALLCopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/copy \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"document_name":"Invoice_2026_Copy","format":"zdoc","password":"string","folder_id":"t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89","resource_type":"fillable","from":"publish","version_id":0,"options":{"include_changes":"none","include_comments":"none","include_template_settings":false}}'

Path Parameters

document_idstring(Required)

The unique ID of the document to copy.

Request Body

application/json
document_namestring(Optional)

A unique name for the copied document.

Maximum Length :255255Copied!
formatstring(Optional)

The format in which to store the copied document.

Allowed Values :
Show Values
docxCopied!
zdocCopied!
odtCopied!
htmlCopied!
pdfCopied!
epubCopied!
rtfCopied!
txtCopied!
Copied!Copy all as JSON Array
Default Value :zdoczdocCopied!
passwordstring(Optional)

A password to protect the copied document. Applicable only for docx and pdf formats.

folder_idstring(Optional)

The ID of the folder in which to store the copy. Defaults to "My Folders".

Maximum Length :100100Copied!
resource_typestring(Optional)

Overrides the document type assigned to the copy.

Allowed Values :
Show Values
fillableCopied!
mergeCopied!
signCopied!
Copied!Copy all as JSON Array
fromstring(Optional)

Indicates the context the copy request originated from. When set to publish, the copy always excludes tracked changes and comments, overriding options.include_changes and options.include_comments.

Allowed Values :
Show Values
publishCopied!
editorCopied!
versionCopied!
dashboardCopied!
Copied!Copy all as JSON Array
version_idinteger(Optional)

The ID of the specific document version to copy. If omitted, the latest version is copied.

optionsJSON Object(Optional)

Controls how tracked changes, comments, and template settings are handled in the copy.

Hide Sub-Attributes
include_changesstring(Optional)

How tracked changes are reflected in the copy. as_markups includes markup annotations; all accepts all changes; none rejects all changes.

Allowed Values :
Show Values
as_markupsCopied!
allCopied!
noneCopied!
Copied!Copy all as JSON Array
Default Value :nonenoneCopied!
include_commentsstring(Optional)

Whether to include comments in the copy. Applicable only for docx and pdf formats.

Allowed Values :
Show Values
allCopied!
noneCopied!
Copied!Copy all as JSON Array
Default Value :nonenoneCopied!
include_template_settingsboolean(Optional)

Whether to include automation configuration in the copy. Applicable only for Sign and Fillable Templates.

Body Parameters

Copied!
  {
    "document_name": "Invoice_2026_Copy",
    "format": "zdoc",
    "password": "string",
    "folder_id": "t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89",
    "resource_type": "fillable",
    "from": "publish",
    "version_id": 0,
    "options": {
      "include_changes": "none",
      "include_comments": "none",
      "include_template_settings": false
    }
  }
                
Show full

Response Example

200
Copied!
  {
    "extension": "zwriter",
    "role": "OWNER",
    "modified_time_ms": 1736426248822,
    "owner_id": "667009621",
    "writer_home_url": "https://writer.zoho.com/documents",
    "is_published": false,
    "shared_time_ms": 1736426248822,
    "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "is_favourite": false,
    "last_opened_time_ms": 1736332736838,
    "thumbnail_url": "https://writer.zoho.com/writer/thumbnail/6yc4z4f557db79e9f446ca37f5702c8b901f6?t_id=4504799000121824571",
    "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "type": "document",
    "title": "New Document",
    "lock_info": {
      "status": false
    },
    "is_orgpublished": false,
    "document_name": "Invoice_2026_001",
    "isWorkflowCompleted": false,
    "modified_time": "2025-01-09T12:37:28Z",
    "library_id": 14,
    "permissions": {
      "can_read_fill": true,
      "can_trash": true,
      "can_share": true,
      "can_edit": true,
      "can_lock": true,
      "can_copy": true,
      "can_org_publish": true,
      "can_read": true,
      "is_admin": false,
      "can_discard_lock": false,
      "can_remove_share": false,
      "can_publish": true,
      "can_delete": false,
      "can_restore": false,
      "can_rename": true,
      "can_favourite": true,
      "can_leave": false,
      "can_download": true,
      "can_unlock": false
    },
    "is_shared": false,
    "download_url": "https://writer.zoho.com/writer/api/v1/download/6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "lastmodified_by": [
      {
        "email_id": "amelia@zylker.com",
        "profile_photo": "https://contacts.zoho.com/file?t=user&ID=950162&fs=thumb",
        "user_id": "950162",
        "timezone": "Asia/Kolkata",
        "language": "en",
        "display_name": "Amelia"
      }
    ],
    "final_info": {
      "status": false
    },
    "parent_info": {
      "folder_name": "My Folders",
      "folder_link": "https://workdrive.zoho.com/home/ep/6oq3d00e1e07d58c64077b4f1c1f28da4a777/privatespace/folders/files"
    },
    "created_time": "2025-01-08T10:38:56Z",
    "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
    "isWorkflowStarted": false,
    "collaboration_id": "2242265600293904878",
    "resource_type": "native",
    "last_opened_time": "2025-01-08T10:38:56Z",
    "version_id": "5719899008834658125",
    "created_by": "Amelia",
    "version": "4.0",
    "created_time_ms": 1736332736838,
    "product_type": 1,
    "preview_url": "https://writer.zoho.com/writer/zwpreview/6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "creator_id": "667009621",
    "name": "Sample Document",
    "permalink": "https://workdrive.zoho.com/file/6yc4z4f557db79e9f446ca37f5702c8b901f6",
    "publish_info": {
      "is_published": false,
      "type": "none",
      "version": "-1"
    },
    "status": "active"
  }
                
Show full