Zoho Writer

Online word processor. Create, copy, publish and organise documents and templates, and merge data into documents to download, save or email.

Actions

Action	What it does
Copy document	Make a copy of a document, optionally in another format or folder.
Copy template	Copy a template, as another template or as a new document.
Create document	Create a document: blank, from text, from a template, or imported from a public file link.
Create template	Create a personal template: blank, from text, from a document, or imported from a public file link.
Delete template	Permanently delete a template.
Get document	Get a document's details: name, links, folder, status and permissions.
Get document fields	List a document's merge fields (the keys 'Merge data' uses), fillable fields and sign fields.
Get document statistics	Count a document's words, characters, comments and tracked changes.
Get template	Get a template's details.
List documents	List the documents the connected account can open, most recently changed first.
List templates	List your personal templates.
Merge and email	Fill a document's merge fields with data and email the result, attached or as the message.
Merge and save	Fill a document's merge fields with data and save the result as new documents in a Zoho WorkDrive folder.
Merge document	Fill a document's merge fields with data and get a download link to the result (valid for two days).
Move document to Trash	Move a document to the Trash.
Publish document	Publish a document to a public web page (or to the organization).
Restore document	Bring a document back from the Trash.
Search documents	Find documents by words in their name or content.
Unpublish document	Take a published document off the web.
Update document	Rename a document or change its description, favourite, lock, final, track-changes or ready state.

Copy document

Make a copy of a document, optionally in another format or folder.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.
Namedocument_nametext: Optional. The copy's name.
Formatoutput_formattext: Optional. The copy's format; a Zoho Writer document by default.One of: zdoc (Zoho Writer document), docx (Word (docx)), odt (OpenDocument (odt)), html, pdf, epub, rtf (Rich text (rtf)), txt (Plain text).
Folder IDfolder_idtext: Optional. The Zoho WorkDrive folder to put it in: a document's parent_folder_id from 'Get document', or the folder's id from its WorkDrive address. Default: My Folders.
Typeresource_typetext: Optional. Make the copy this kind of document.One of: fillable (Fillable form), merge (Merge template), sign (Sign template).
Tracked changesinclude_changestext: Optional. What to do with tracked changes.One of: as_markups (Keep as markup), all (Accept all), none (Drop them).
Commentsinclude_commentstext: Optional. Whether to copy the comments.One of: all (Copy all), none (Leave out).
Include template settingsinclude_template_settingstrue/false: Optional. Also copy merge and template settings.

Outputs

A Zoho Writer document.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
document_idtext: The document's id; pass it to the other document actions.
document_nametext: The document's name.
document_typetext: The kind of document.
download_urltext: The API download link.
final_infoobject: Final state.
idtext: The document's id (same as document_id).
is_favouritetrue/false: Whether it is a favourite.
is_publishedtrue/false: Whether it is published.
is_sharedtrue/false: Whether it is shared.
last_opened_timetext: An ISO 8601 UTC timestamp.
lastmodified_bylist: Who changed it last.
lock_infoobject: Lock state.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The document's file name.
open_urltext: Opens the document in Zoho Writer.
owner_idtext: The owner's Zoho id.
parent_folder_idtext: The WorkDrive folder it is in; usable as a Folder ID.
parent_infoobject: The folder it is in.
permalinktext: The document's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
published_urltext: The public link, when published.
resource_typetext: native, fillable, merge, sign or label.
roletext: The connected account's role on it, such as OWNER.
statustext: active, or trashed.
thumbnail_urltext: A thumbnail image.
typetext: Always 'document'.
versiontext: The current version.

Example output

{
  "created_time": "2026-08-01T10:38:56Z",
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "document_name": "Quarterly report",
  "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "is_favourite": false,
  "is_published": false,
  "modified_time": "2026-08-02T12:37:28Z",
  "name": "Quarterly report",
  "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
  "resource_type": "native",
  "role": "OWNER",
  "status": "active",
  "type": "document"
}

Copy template

Copy a template, as another template or as a new document.

Inputs

Templatetemplate_idtextRequired: The template. Pick one of your recent templates, or type its id (from 'List templates').
Namenametext: Optional. The copy's name; 'Copy of …' by default.
Save assave_astext: Optional. A template (default) or a document.One of: template, document.

Outputs

The copy: a template, or a document when saved as one.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
document_idtext: The new document's id, when saved as a document.
document_nametext: The new document's name, when saved as a document.
idtext: The copy's id; a template id, or a document id when saved as one.
last_opened_timetext: An ISO 8601 UTC timestamp.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The template's name.
open_urltext: Opens the template in Zoho Writer.
owner_idtext: The owner's Zoho id.
parent_folder_idtext: The new document's folder, when saved as a document.
permalinktext: The template's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
saved_astext: template or document.
statustext: The template's status.
thumbnail_urltext: A thumbnail image.
typetext: template or document.

Example output

{
  "created_time": "2026-08-01T16:30:33Z",
  "id": "a7iyybadbb8b74e1147638bad04abc161e79e",
  "modified_time": "2026-08-01T16:30:34Z",
  "name": "Invoice template",
  "open_url": "https://writer.zoho.com/writer/template/a7iyybadbb8b74e1147638bad04abc161e79e",
  "saved_as": "template",
  "status": "active",
  "type": "template"
}

Create document

Create a document: blank, from text, from a template, or imported from a public file link.

Inputs

Namefilenametext: Optional. The document's name.
Texttexttext: Optional. Text to start the document with.
Templatetemplate_idtext: Optional. Start from this template instead.
Import from URLurltext: Optional. A public link to a file (such as a .docx) to import instead. Give at most one of Text, Template and this.
Folder IDfolder_idtext: Optional. The Zoho WorkDrive folder to put it in: a document's parent_folder_id from 'Get document', or the folder's id from its WorkDrive address. Default: My Folders.
Typeresource_typetext: Optional. A special kind of document; a normal one by default.One of: fillable (Fillable form), merge (Merge template), sign (Sign template), label.

Outputs

A Zoho Writer document.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
document_idtext: The document's id; pass it to the other document actions.
document_nametext: The document's name.
document_typetext: The kind of document.
download_urltext: The API download link.
final_infoobject: Final state.
idtext: The document's id (same as document_id).
is_favouritetrue/false: Whether it is a favourite.
is_publishedtrue/false: Whether it is published.
is_sharedtrue/false: Whether it is shared.
last_opened_timetext: An ISO 8601 UTC timestamp.
lastmodified_bylist: Who changed it last.
lock_infoobject: Lock state.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The document's file name.
open_urltext: Opens the document in Zoho Writer.
owner_idtext: The owner's Zoho id.
parent_folder_idtext: The WorkDrive folder it is in; usable as a Folder ID.
parent_infoobject: The folder it is in.
permalinktext: The document's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
published_urltext: The public link, when published.
resource_typetext: native, fillable, merge, sign or label.
roletext: The connected account's role on it, such as OWNER.
statustext: active, or trashed.
thumbnail_urltext: A thumbnail image.
typetext: Always 'document'.
versiontext: The current version.

Example output

{
  "created_time": "2026-08-01T10:38:56Z",
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "document_name": "Quarterly report",
  "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "is_favourite": false,
  "is_published": false,
  "modified_time": "2026-08-02T12:37:28Z",
  "name": "Quarterly report",
  "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
  "resource_type": "native",
  "role": "OWNER",
  "status": "active",
  "type": "document"
}

Create template

Create a personal template: blank, from text, from a document, or imported from a public file link.

Inputs

Namenametext: Optional. The template's name.
Texttexttext: Optional. Text to start the template with.
From documentdocument_idtext: Optional. Make the template from this document or template.
Import from URLurltext: Optional. A public link to a file to import instead. Give at most one of Text, From document and this.

Outputs

A Zoho Writer template.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
idtext: The template's id; pass it to the other template actions.
last_opened_timetext: An ISO 8601 UTC timestamp.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The template's name.
open_urltext: Opens the template in Zoho Writer.
owner_idtext: The owner's Zoho id.
permalinktext: The template's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
statustext: The template's status.
thumbnail_urltext: A thumbnail image.
typetext: Always 'template'.

Example output

{
  "created_time": "2026-08-01T16:30:33Z",
  "id": "a7iyybadbb8b74e1147638bad04abc161e79e",
  "modified_time": "2026-08-01T16:30:34Z",
  "name": "Invoice template",
  "open_url": "https://writer.zoho.com/writer/template/a7iyybadbb8b74e1147638bad04abc161e79e",
  "status": "active",
  "type": "template"
}

Delete template

Permanently delete a template. Templates have no Trash, so this cannot be undone.

Inputs

Templatetemplate_idtextRequired: The template. Pick one of your recent templates, or type its id (from 'List templates').

Outputs

The permanently deleted template.

deletedtrue/false: Always true.
deleted_byobject: A Zoho user.
messagetext: Zoho's confirmation.
template_idtext: The template's id.

Example output

{
  "deleted": true,
  "message": "Template deleted successfully.",
  "template_id": "a7iyybadbb8b74e1147638bad04abc161e79e"
}

Get document

Get a document's details: name, links, folder, status and permissions.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

A Zoho Writer document.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
document_idtext: The document's id; pass it to the other document actions.
document_nametext: The document's name.
document_typetext: The kind of document.
download_urltext: The API download link.
final_infoobject: Final state.
idtext: The document's id (same as document_id).
is_favouritetrue/false: Whether it is a favourite.
is_publishedtrue/false: Whether it is published.
is_sharedtrue/false: Whether it is shared.
last_opened_timetext: An ISO 8601 UTC timestamp.
lastmodified_bylist: Who changed it last.
lock_infoobject: Lock state.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The document's file name.
open_urltext: Opens the document in Zoho Writer.
owner_idtext: The owner's Zoho id.
parent_folder_idtext: The WorkDrive folder it is in; usable as a Folder ID.
parent_infoobject: The folder it is in.
permalinktext: The document's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
published_urltext: The public link, when published.
resource_typetext: native, fillable, merge, sign or label.
roletext: The connected account's role on it, such as OWNER.
statustext: active, or trashed.
thumbnail_urltext: A thumbnail image.
typetext: Always 'document'.
versiontext: The current version.

Example output

{
  "created_time": "2026-08-01T10:38:56Z",
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "document_name": "Quarterly report",
  "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "is_favourite": false,
  "is_published": false,
  "modified_time": "2026-08-02T12:37:28Z",
  "name": "Quarterly report",
  "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
  "resource_type": "native",
  "role": "OWNER",
  "status": "active",
  "type": "document"
}

Get document fields

List a document's merge fields (the keys 'Merge data' uses), fillable fields and sign fields.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

The document's merge, fillable and sign fields.

document_idtext: The document's id.
filllist: The fillable fields.
mergelist: The merge fields.
merge_field_idslist: The merge fields' ids: use them as the keys of 'Merge data'.
signobject: Sign fields, by recipient.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "fill": [],
  "merge": [
    {
      "display_name": "Name",
      "id": "name",
      "type": "text"
    }
  ],
  "merge_field_ids": [
    "name"
  ],
  "sign": {}
}

Get document statistics

Count a document's words, characters, comments and tracked changes.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

Statistics about the document's content, comments and tracked changes.

comments_metricsobject: Comment counts.
content_metricsobject: Counts of the text.
document_idtext: The document's id.
tracked_changes_metricsobject: Tracked-change counts.

Example output

{
  "comments_metrics": {
    "all": 2,
    "resolved": 1,
    "unresolved": 1
  },
  "content_metrics": {
    "number_of_characters": 700,
    "number_of_characters_without_whitespaces": 590,
    "number_of_sentences": 9,
    "number_of_words": 120
  },
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6"
}

Get template

Get a template's details.

Inputs

Templatetemplate_idtextRequired: The template. Pick one of your recent templates, or type its id (from 'List templates').

Outputs

A Zoho Writer template.

created_bytext: Who created it.
created_timetext: An ISO 8601 UTC timestamp.
created_time_msnumber: The same moment in Unix milliseconds.
creator_idtext: The creator's Zoho id.
idtext: The template's id; pass it to the other template actions.
last_opened_timetext: An ISO 8601 UTC timestamp.
modified_timetext: An ISO 8601 UTC timestamp.
modified_time_msnumber: The same moment in Unix milliseconds.
nametext: The template's name.
open_urltext: Opens the template in Zoho Writer.
owner_idtext: The owner's Zoho id.
permalinktext: The template's permanent link.
permissionsobject: What the connected account may do with it.
preview_urltext: A read-only preview.
statustext: The template's status.
thumbnail_urltext: A thumbnail image.
typetext: Always 'template'.

Example output

{
  "created_time": "2026-08-01T16:30:33Z",
  "id": "a7iyybadbb8b74e1147638bad04abc161e79e",
  "modified_time": "2026-08-01T16:30:34Z",
  "name": "Invoice template",
  "open_url": "https://writer.zoho.com/writer/template/a7iyybadbb8b74e1147638bad04abc161e79e",
  "status": "active",
  "type": "template"
}

List documents

List the documents the connected account can open, most recently changed first.

Inputs

Categorycategorytext: Optional. Which documents; all of them by default.One of: all, owned_by_me (Owned by me), shared_to_me (Shared with me), favourite (Favourites), trashed (In the Trash), recent.
Document typesresource_typestext: Optional. Only these kinds of document.One or more of: fillable (Fillable form), merge (Merge template), sign (Sign template), label.
Sort bysort_bytext: Optional. What to sort by.One of: modified_time (Last changed), created_time (Created), shared_time (Shared), name.
Sort ordersort_ordertext: Optional. Newest or largest first by default.One of: descending, ascending.
Page sizelimitnumber: Optional. How many to return, 1 to 100. Default 10.From 1 to 100.
Offsetoffsetnumber: Optional. How many to skip: the next_offset of the previous page.At least 0.

Outputs

countnumber: How many documents are on this page.
documentslist: The documents.
has_moretrue/false: Whether another page is available.
next_offsetnumber: Pass as 'Offset' to fetch the next page; empty on the last.
total_countnumber: How many documents there are in all, when Zoho says.

Example output

{
  "count": 1,
  "documents": [
    {
      "created_time": "2026-08-01T10:38:56Z",
      "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "document_name": "Quarterly report",
      "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "is_favourite": false,
      "is_published": false,
      "modified_time": "2026-08-02T12:37:28Z",
      "name": "Quarterly report",
      "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
      "resource_type": "native",
      "role": "OWNER",
      "status": "active",
      "type": "document"
    }
  ],
  "has_more": false,
  "next_offset": null,
  "total_count": 1
}

List templates

List your personal templates.

Inputs

Sort bysort_bytext: Optional. What to sort by.One of: name, created_time (Created), modified_time (Last changed).
Page sizelimitnumber: Optional. How many to return, 1 to 100. Default 50.From 1 to 100.
Offsetoffsetnumber: Optional. How many to skip: the next_offset of the previous page.At least 0.

Outputs

countnumber: How many templates are on this page.
has_moretrue/false: Whether another page is available.
next_offsetnumber: Pass as 'Offset' to fetch the next page; empty on the last.
templateslist: The templates.
total_countnumber: How many templates there are in all, when Zoho says.

Example output

{
  "count": 1,
  "has_more": false,
  "next_offset": null,
  "templates": [
    {
      "created_time": "2026-08-01T16:30:33Z",
      "id": "a7iyybadbb8b74e1147638bad04abc161e79e",
      "modified_time": "2026-08-01T16:30:34Z",
      "name": "Invoice template",
      "open_url": "https://writer.zoho.com/writer/template/a7iyybadbb8b74e1147638bad04abc161e79e",
      "status": "active",
      "type": "template"
    }
  ],
  "total_count": 1
}

Merge and email

Fill a document's merge fields with data and email the result, attached or as the message. The free plan sends 10 a day.

Inputs

Documentdocument_idtextRequired: The document with the merge fields. Pick one of your recent documents, or type its id or paste its address.
Torecipient_emailtextRequired: Up to 10 email addresses, separated by commas.
SubjectsubjecttextRequired: The email's subject.
Send asoutput_formattextRequired: Attach the merged document in this format, or put it in the email body.One of: pdf, docx (Word (docx)), inline (In the email body), pdfform (Fillable PDF (5 credits a record)).
Messagemessage_bodytext: Optional. The email's text, when the document is attached.
CCcc_emailtext: Optional. Up to 10 addresses, separated by commas.
BCCbcc_emailtext: Optional. Up to 10 addresses, separated by commas.
From namefrom_nametext: Optional. The sender name shown.
Reply-toreplyto_emailtext: Optional. Where replies go.
Attachment nameattachment_nametext: Optional. The attached file's name.
Merge datamerge_dataobject: The values to merge: an object of merge-field id to value, such as {"name": "Amelia", "email": "amelia@example.com"}, or a list of such objects for one merge per record. 'Get document fields' lists the ids. Give this or one of the data URLs.
Merge data JSON URLmerge_data_json_urltext: Optional. A public https link to a JSON file of the records, instead of 'Merge data'.
Merge data CSV URLmerge_data_csv_urltext: Optional. A public https link to a CSV file of the records, instead of 'Merge data'.
Test modetest_modetrue/false: Optional. Run without using merge credits; the result is watermarked and Zoho allows 50 test merges a day.Default: false.

Outputs

The merge job. It runs in the background; the report links show progress.

document_idtext: The merged document's id.
merge_report_data_urltext: The merge report as data.
merge_report_urltext: The merge report page.
recordslist: One entry per record.
statustext: inprogress, or the outcome.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "merge_report_url": "https://writer.zoho.com/writer/v1/mailmerge/job/0tq5n4",
  "records": [
    {
      "data": {
        "name": "Amelia"
      },
      "download_link": "https://writer.zoho.com/writer/api/v1/documents/6yc4z4f557db79e9f446ca37f5702c8b901f6/merge/download/gas3hfnkju456mndhjku987b",
      "status": "inprogress"
    }
  ],
  "status": "inprogress"
}

Merge and save

Fill a document's merge fields with data and save the result as new documents in a Zoho WorkDrive folder. Runs in the background.

Inputs

Documentdocument_idtextRequired: The document with the merge fields. Pick one of your recent documents, or type its id or paste its address.
New document namedoc_nametextRequired: The name of the saved document(s).
Folder IDfolder_idtextRequired: The Zoho WorkDrive folder to save into: a document's parent_folder_id from 'Get document', or the folder's id from its WorkDrive address.
Formatoutput_formattext: Optional. Save as this format; a Zoho Writer document by default.One of: pdf, docx (Word (docx)), pdfform (Fillable PDF (5 credits a record)).
Merge intomerge_totext: Optional. One document per record (default) or one for all.One of: separatedoc (One document per record), singledoc (One document for all records).
Overwrite existing fileoverwrite_existing_filetrue/false: Optional. Replace a file of the same name in the folder.
Merge datamerge_dataobject: The values to merge: an object of merge-field id to value, such as {"name": "Amelia", "email": "amelia@example.com"}, or a list of such objects for one merge per record. 'Get document fields' lists the ids. Give this or one of the data URLs.
Merge data JSON URLmerge_data_json_urltext: Optional. A public https link to a JSON file of the records, instead of 'Merge data'.
Merge data CSV URLmerge_data_csv_urltext: Optional. A public https link to a CSV file of the records, instead of 'Merge data'.
Test modetest_modetrue/false: Optional. Run without using merge credits; the result is watermarked and Zoho allows 50 test merges a day.Default: false.

Outputs

The merge job. It runs in the background; the report links show progress.

document_idtext: The merged document's id.
merge_report_data_urltext: The merge report as data.
merge_report_urltext: The merge report page.
recordslist: One entry per record.
statustext: inprogress, or the outcome.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "merge_report_url": "https://writer.zoho.com/writer/v1/mailmerge/job/0tq5n4",
  "records": [
    {
      "data": {
        "name": "Amelia"
      },
      "download_link": "https://writer.zoho.com/writer/api/v1/documents/6yc4z4f557db79e9f446ca37f5702c8b901f6/merge/download/gas3hfnkju456mndhjku987b",
      "status": "inprogress"
    }
  ],
  "status": "inprogress"
}

Merge document

Fill a document's merge fields with data and get a download link to the result (valid for two days). Uses merge credits unless 'Test mode' is on.

Inputs

Documentdocument_idtextRequired: The document with the merge fields. Pick one of your recent documents, or type its id or paste its address.
Output formatoutput_formattextRequired: The merged file's format.One of: pdf, docx (Word (docx)), html, zdoc (Zoho Writer document), pdfform (Fillable PDF (5 credits a record)).
File namefilenametext: Optional. The merged file's name, without an extension.
Merge datamerge_dataobject: The values to merge: an object of merge-field id to value, such as {"name": "Amelia", "email": "amelia@example.com"}, or a list of such objects for one merge per record. 'Get document fields' lists the ids. Give this or one of the data URLs.
Merge data JSON URLmerge_data_json_urltext: Optional. A public https link to a JSON file of the records, instead of 'Merge data'.
Merge data CSV URLmerge_data_csv_urltext: Optional. A public https link to a CSV file of the records, instead of 'Merge data'.
Test modetest_modetrue/false: Optional. Run without using merge credits; the result is watermarked and Zoho allows 50 test merges a day.Default: false.

Outputs

The merged file.

document_idtext: The merged document's id.
download_urltext: Downloads the merged file; it expires after two days.
formattext: The file format.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "download_url": "https://writer.zoho.com/writer/api/v1/documents/6yc4z4f557db79e9f446ca37f5702c8b901f6/merge/download/gas3hfnkju456mndhjku987b",
  "format": "pdf"
}

Move document to Trash

Move a document to the Trash. 'Restore document' brings it back.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

The document moved to the Trash.

document_idtext: The document's id.
messagetext: Zoho's confirmation.
resulttext: 'success'.
retention_dataobject: How long a WorkDrive team keeps it.
trashedtrue/false: Always true.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "message": "Document moved to trash.",
  "result": "success",
  "trashed": true
}

Publish document

Publish a document to a public web page (or to the organization).

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.
Publish toscopetext: Optional. Anyone with the link (default), or only your Zoho WorkDrive team.One of: external (Anyone (public)), organization (My organization).
Republish on saveauto_republishtrue/false: Optional. Update the published page whenever the document is saved. On by default.
Titletitletext: Optional. The published page's title.
Descriptiondescriptiontext: Optional. The published page's description.
Keywordskeywordstext: Optional. Search keywords (public pages only).
Allow downloadallow_downloadtrue/false: Optional. Let readers download it.
Allow embeddingallow_embedtrue/false: Optional. Let other sites embed it.
Show authorshow_authortrue/false: Optional. Show who wrote it.
Show reading timeshow_reading_timetrue/false: Optional. Show an estimated reading time.
Show view countshow_view_counttrue/false: Optional. Show how many times it was viewed.
Show navigationshow_navigationtrue/false: Optional. Show a table of contents.
Allow search enginessearch_indexingtrue/false: Optional. Let search engines index it (public pages only).
Show social media buttonssocial_mediatrue/false: Optional. Show share buttons (public pages only).

Outputs

The published document.

auto_republishtrue/false: Whether saving republishes it.
document_idtext: The document's id.
messagetext: Zoho's confirmation.
published_settingsobject: The settings in effect.
published_urltext: The public link.
resulttext: 'success'.
scopetext: external or organization.

Example output

{
  "auto_republish": true,
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "published_url": "https://writer.zoho.com/writer/published/abc123",
  "result": "success",
  "scope": "external"
}

Restore document

Bring a document back from the Trash.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

The document restored from the Trash.

document_idtext: The document's id.
messagetext: Zoho's confirmation.
restoredtrue/false: Always true.
resulttext: 'success'.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "message": "Document restored.",
  "restored": true,
  "result": "success"
}

Search documents

Find documents by words in their name or content.

Inputs

Search textquerytextRequired: The words to search for.
Date rangedate_rangetext: Optional. Only documents from this period. Applies to WorkDrive team accounts; 'Custom dates' needs From and To.One of: today, yesterday, last_week (Last week), last_month (Last month), last_year (Last year), custom_date (Custom dates).
Fromstart_timedate and time: Optional. With 'To': only documents from this moment on.
Toend_timedate and time: Optional. With 'From': only documents up to this moment.
Sort bysort_bytext: Optional. What to sort by; relevance by default.One of: name, created_time (Created), modified_time (Last changed).
Sort ordersort_ordertext: Optional. Newest or largest first by default.One of: descending, ascending.
Page sizelimitnumber: Optional. How many to return. Default 50.At least 1.
Offsetoffsetnumber: Optional. How many to skip: the next_offset of the previous page.At least 0.

Outputs

countnumber: How many documents are on this page.
documentslist: The documents.
has_moretrue/false: Whether another page is available.
next_offsetnumber: Pass as 'Offset' to fetch the next page; empty on the last.
total_countnumber: How many documents there are in all, when Zoho says.

Example output

{
  "count": 1,
  "documents": [
    {
      "created_time": "2026-08-01T10:38:56Z",
      "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "document_name": "Quarterly report",
      "id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "is_favourite": false,
      "is_published": false,
      "modified_time": "2026-08-02T12:37:28Z",
      "name": "Quarterly report",
      "open_url": "https://writer.zoho.com/writer/open/6yc4z4f557db79e9f446ca37f5702c8b901f6",
      "parent_folder_id": "qpz9g646b2ddd954247b3988165bc17c156fe",
      "resource_type": "native",
      "role": "OWNER",
      "status": "active",
      "type": "document"
    }
  ],
  "has_more": false,
  "next_offset": null,
  "total_count": 1
}

Unpublish document

Take a published document off the web.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.

Outputs

The unpublished document.

document_idtext: The document's id.
messagetext: Zoho's confirmation.
resulttext: 'success'.
scopetext: The scope it was removed from.
unpublishedtrue/false: Always true.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "result": "success",
  "scope": "external",
  "unpublished": true
}

Update document

Rename a document or change its description, favourite, lock, final, track-changes or ready state. Only the fields you fill in change.

Inputs

Documentdocument_idtextRequired: The document. Pick one of your recent documents, or type its id (from 'List documents') or paste its address, such as https://writer.zoho.com/writer/open/<id>.
New namenametext: Optional. Rename the document.
Descriptiondescriptiontext: Optional. A new description, up to 200 characters.
Favouritefavouritetext: Optional. Add to or remove from favourites.One of: add (Add to favourites), remove (Remove from favourites).
Track changestrack_changestext: Optional. Turn change tracking on or off.One of: enable (On), disable (Off).
Finalfinaltext: Optional. Mark the document final (read-only) or not.One of: mark_final (Mark as final), unmark_final (Unmark final).
Mark as readymark_readytrue/false: Optional. Mark a draft document ready (complete).
Locklocktext: Optional. Lock or unlock the document; applied last.One of: lock, unlock.

Outputs

What changed. Each change is its own call to Zoho; their answers are merged.

descriptiontext: The new description, when changed.
document_idtext: The document's id.
final_infoobject: Final state, when changed.
is_favouritetrue/false: Whether it is a favourite, when changed.
locked_byobject: Who locked it, when locked.
messagetext: Zoho's confirmation of the last change.
modified_byobject: A Zoho user.
nametext: The new name, when renamed.
resulttext: 'success'.
statetext: The new state, when marked ready.
unlocked_byobject: Who unlocked it, when unlocked.
updated_fieldslist: The details changed, in order.

Example output

{
  "document_id": "6yc4z4f557db79e9f446ca37f5702c8b901f6",
  "message": "Document renamed successfully.",
  "name": "Quarterly report (final)",
  "result": "success",
  "updated_fields": [
    "name"
  ]
}

ActionsCopy Anchor Link

Copy documentCopy Anchor Link

Inputs

Outputs

Copy templateCopy Anchor Link

Inputs

Outputs

Create documentCopy Anchor Link

Inputs

Outputs

Create templateCopy Anchor Link

Inputs

Outputs

Delete templateCopy Anchor Link

Inputs

Outputs

Get documentCopy Anchor Link

Inputs

Outputs

Get document fieldsCopy Anchor Link

Inputs

Outputs

Get document statisticsCopy Anchor Link

Inputs

Outputs

Get templateCopy Anchor Link

Inputs

Outputs

List documentsCopy Anchor Link

Inputs

Outputs

List templatesCopy Anchor Link

Inputs

Outputs

Merge and emailCopy Anchor Link

Inputs

Outputs

Merge and saveCopy Anchor Link

Inputs

Outputs

Merge documentCopy Anchor Link

Inputs

Outputs

Move document to TrashCopy Anchor Link

Inputs

Outputs

Publish documentCopy Anchor Link

Inputs

Outputs

Restore documentCopy Anchor Link

Inputs

Outputs

Search documentsCopy Anchor Link

Inputs

Outputs

Unpublish documentCopy Anchor Link

Inputs

Outputs

Update documentCopy Anchor Link

Inputs

Outputs

On this page

Actions

Copy document

Copy template

Create document

Create template

Delete template

Get document

Get document fields

Get document statistics

Get template

List documents

List templates

Merge and email

Merge and save

Merge document

Move document to Trash

Publish document

Restore document

Search documents

Unpublish document

Update document