Zoho Writer API Docs

The Zoho Writer API allows client applications to view, list, edit, create, save & perform a host of useful operations on their documents. It is loosely based on the XML-RPC specification that allows software running on disparate operating systems and different environments to make procedure calls over the internet. See the XML-RPC specification for more information.

This API provides an easy way to integrate Zoho Services into your application. To perform an action using the Zoho Writer API, you need to choose a calling convention (GET/POST), send a request specifying the method name and some arguments. In return, you will recieve a fomatted response from the called method.

API URL

To access the API, use the following URL as mentioned below :

http://export.writer.zoho.com/api?ticket=[user ticket id]&apikey=[apikey]&documentid=[docid]

Note:

-- It is mandatory to specify the ticket id in the URL as it is used for API authentication.
-- xml tags marked in grey color text are optional.

API Methods

writer.getDocuments - Get the list of documents.
writer.viewDocument - View a particular document contents.
writer.newDocument - Create a new document.
writer.saveDocument - Edit & Save the document contents.
writer.uploadImage - Upload an image to the document.
writer.getSharedDocuments - Get the list of shared documents.
writer.getTrashedDocuments - Get the list of trashed documents.
writer.trashDocument - Trash an existing document.
writer.deleteDocument - Delete the document permanently.
writer.tags.addTag - Add a tag to document.
writer.tags.deleteTag - Delete an existing tag associated with the document.
writer.tags.getdocuments - Get the list of documents having similar tag name.

Note:

-- You can also use the "GET Method" calling convention for getDocuments & viewDocument Methods. In case of viewDocument method, it is mandatory to pass "documentid" as a parameter during GET method call. For others we support only "POST Method" calling convention.

Error Report

The list of exceptions that a user will get as a response to invalid input during method call can be viewed here.