Create 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 Zoho Writer document, optionally populated from an uploaded file, a web URL, plain text, or an existing template to create from. If none of those is provided, a blank document is created.


Provide at most one of content, url, text, or template_id.

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 \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'content=@file_path' \
  -F 'text=Invoice details for Q1 2026.' \
  -F 'url=https://zylker.com/sample-invoice.docx' \
  -F 'template_id=t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89' \
  -F 'filename=Invoice_2026_001' \
  -F 'password=string' \
  -F 'resource_type=fillable' \
  -F 'folder_id=t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89'

Request Body

multipart/form-data
contentbinary(Optional)

The file to upload as the new document's content. Supported formats: docx (up to 50 MB), rtf, html, txt, odt (up to 10 MB).

textstring(Optional)

The plain text content to populate the new document with.

Maximum Length :100000100000Copied!
urluri(Optional)

A publicly accessible URL from which to import the document content. The fetched content must not exceed 10 MB.

Maximum Length :50005000Copied!
template_idstring(Optional)

The unique ID of an existing template to copy as the new document.

filenamestring(Optional)

A name for the new document.

Maximum Length :255255Copied!
passwordstring(Optional)

The password to unlock the uploaded content file, if it is password-protected.

Maximum Length :255255Copied!
resource_typestring(Optional)

The type of document to create.

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

The ID of the folder in which to place the new document.

Maximum Length :100100Copied!

Body Parameters

Copied!
// Note: payload contains multiple type attributes

// type: file
content = <file>

// type: string
text = Invoice details for Q1 2026.

// type: string(uri)
url = https://zylker.com/sample-invoice.docx

// type: string
template_id = t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89

// type: string
filename = Invoice_2026_001

// type: string
password = string

// type: string
resource_type = fillable

// type: string
folder_id = t04apjk9p7d6ba94f4cbf9c56e1b1ed9bac89
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