File And Document Management

Zoho Writer

The Zoho Writer modules allow you to monitor, create, merge, upload, send, retrieve, list, and delete the documents and folders in your Zoho Writer account.

Getting Started with Zoho Writer

Prerequisites

Connect Zoho Writer to Boost.space Integrator

  1. Log in to your Boost.space Integrator and open the Zoho Writer module and click Add next to the Connection field.

    msedge_yWOYXWzFHi.gif

  2. In the Connection name field, enter a name for the connection.

  3. Optional: Click Show Advanced Settings and enter the client credentials. See Create your custom app and client credentials.

    msedge_gpPZIuMx8I.png

  4. Click Save.

  5. Confirm the access by clicking Accept.

    61d6bf7a37228.png

The connection has been established.

Create your custom app and client credentials

To create your own app:

  1. Log in to your Zoho Developer account.

  2. Click ADD CLIENT and choose a client type.

    bigin-zoho-crm-5.png

  3. Enter the app detail as described below and click CREATE.

    bigin-zoho-crm-8.png

    Client Name

    Enter the application name you want to register with Zoho.

    Homepage URL

    Enter the homepage URL, for example, https://www.make.com/en.

    Redirect URI

    Add, https://integrator.boost.space/oauth/cb/zohocrm2

  4. Copy the Client ID and Client Secret to a safe place.

    bigin-zoho-crm-7.png

You have successfully retrieved the client credentials.

Documents

Using the following modules, you can watch, create, update, list, retrieve, restore, copy, move, trash, and merge documents.

Watch Documents

Triggers when a new document has been added.

Connection

Establish a connection to your Zoho Writer account.

Limit

Set the maximum number of documents Boost.space Integrator should return during one execution cycle.

Watch Favorite Documents

Triggers when a new favorite document has been added.

Connection

Establish a connection to your Zoho Writer account.

Limit

Set the maximum number of favorite documents Boost.space Integrator should return during one execution cycle.

List Documents

Lists all documents.

Connection

Establish a connection to your Zoho Writer account.

Sort By

Select or map the option to sort the documents you want to list:

  • Created Time
  • Modified Time
  • Last Opened Time

Category

Select or map the option to list the documents from the specified category:

  • All
  • Favorite
  • Shared to me
  • Owned by me
  • Trashed

Limit

Set the maximum number of documents Boost.space Integrator should return during one execution cycle.

Get a Document

Retrieves a document by ID.

Connection

Establish a connection to your Zoho Writer account.

Document ID

Select or map the Document ID whose details you want to retrieve.

Create a Document

Creates a document by uploading a file. Providing a URL or plain text of a document.

Required Permissions: ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL, WorkDrive.files.ALL

Connection

Establish a connection to your Zoho Writer account.

Adding Method

Select or map the method by which you want to create the document.

URL

Enter (map) the public URL address of the file for which you want to create the document.

Text

Enter (map) the complete text that you want to add to the document as content.

Password

Enter (map) the password if you want the document to be protected.

File Name

Enter (map) the file or document name.

Folder Name

Enter (map) the folder name.

Upload a Document

Uploads a new document.

**Required Permissions:**ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL, WorkDrive.files.ALL

Connection

Establish a connection to your Zoho Writer account.

File

Enter (map) a file name.

File Name

Enter (map) the file or document name.

Password

Enter (map) the password if you want the document to be protected.

Folder Name

Enter (map) the folder name.

Restore a Document

Restores a document from a trash bin.

Connection

Establish a connection to your Zoho Writer account.

Document ID

Select or map the Document ID you want to restore.

Copy a Document

Copies an existing document.

Connection

Establish a connection to your Zoho Writer account.

Document ID

Select or map the Document ID you want to copy

Document Name

Enter (map) the document name.

Format

Enter (map) the format.

Password

Enter (map) the document a password.

Folder Name

Enter (map) the folder name to copy.

Include Changes

Select or map the include changes you want to make.

Merge a Document

Merges a document and stores it in a Zoho folder.

Required Permissions: ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL, WorkDrive.files.ALL, ZohoWriter.merge.ALL

Connection

Establish a connection to your Zoho Writer account

Document Name

Select or map the Document ID you want to trash.

Folder ID

Select or map the Folder ID where you want to store the merged document.

Document ID

Select or map the Document ID which you want to merge.

Merging Format

Select or map the format to which you want to merge the document:

  • Choose Fields
  • CSV Content
  • JSON Content
  • JSON URL
  • CSV URL

Output Format

Select or map the format in which you want to store the merged document:

  • DOC
  • PDF

Note: If no output format is specified, the merged document is stored in Writer format (zdoc) by default.

Password

Enter (map) the password if you want to protect the merged document.

Merge a Document to Send via Email

Merges a document and sends it via email.

Required Permissions: ZohoWriter.documentEditor.ALL, ZohoWriter.merge.ALL

Connection

Establish a connection to your Zoho Writer account.

Subject

Enter (map) the subject line of the email.

Recipient Email

Enter (map) the email address of the recipient to whom you want to send the merged document.

Document ID

Select or map the Document ID which you want to merge and send.

CC Email

Enter (map) the email addresses you want to add in the CC field to the email.

BCC Email

Enter (map) the email address you want to add in the BCC field of the email.

From Email

Enter (map) the email address from which you want to send the merged document email

Trash a Document

Moves a document into a trash bin.

Connection

Establish a connection to your Zoho Writer account.

Document ID

Select or map the Document ID you want to trash.

Delete a Trashed Document

Permanently deletes a trashed document.

Connection

Establish a connection to your Zoho Writer account.

Document ID

Select or map the Document ID from the trash which you want to delete.

Other

You can APIs using the following module.

Make an API Call

Performs an arbitrary authorized API Call.

Connection

Establish a connection to your Zoho Writer account.

URL

Enter a path relative to https://www.zohoapis.com/writer/api. For example, /v1/documents.

For the list of available endpoints, refer to the Zoho Writer API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – List Folders

The following API call returns all the folders from your Zoho Writer account:

URL:

/v1/folders

Method:

GET

61d6bf7b81038.png

Matches of the search can be found in the module’s Output under Bundle > Body > folders.

In our example, 4 folders were returned:

61d6bf7cb6416.png

Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/file-and-document-management/zoho-writer/).

Previous
Zoho Sign
Next
HR management