Download Document

Downloads a Zoho Writer document in the specified file format, with options to control how tracked changes, comments, and styles are rendered, or to format signature fields for compatibility with a third-party e-signature service.

Endpoints

get https://www.zohoapis.com/writer/api/v1/download/{document_id}

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALLCopied!

curl --request GET \
  --url 'https://www.zohoapis.com/writer/api/v1/download/a1b2c3d4e5f6g7h8i9?format=SOME_STRING_VALUE&options=[object Object]&sign_service_name=SOME_STRING_VALUE&password=SOME_STRING_VALUE' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'


    parameters = "format=value" + "&" + "options=value" + "&" + "sign_service_name=value" + "&" + "password=value";


    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/download/{document_id}" + "?" + parameters
        type: GET
        connection: connection_name
    ]

    info response;

Path Parameters

document_idstring(Required)

The unique ID of the document to download.

Query Parameters

formatstring(Optional)

The format in which to download the document.

Allowed Values :

Show Values ▾

Default Value :docxCopied!

optionsJSON Object(Optional)

Controls how tracked changes, comments, and styles appear in the downloaded file.

Hide Sub-Attributes

include_changesstring(Optional)

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

Allowed Values :

Show Values ▾

Default Value :noneCopied!

include_commentsstring(Optional)

Whether to include comments in the downloaded file. all includes them; none excludes them. Applicable only for docx and pdf formats.

Allowed Values :

Show Values ▾

Default Value :noneCopied!

include_stylesstring(Optional)

Whether to include styles. as_inline retains font colors and sizes as inline styles; none retains only headings, basic formatting, and hyperlinks. Applicable only for html and zip formats.

Allowed Values :

Show Values ▾

Default Value :as_inlineCopied!

sign_service_namestring(Optional)

The third-party e-signature service used to format signature-field tags in the downloaded PDF, so the file is compatible if later uploaded to that service. Applicable only when format is pdf.

Allowed Values :

Show Values ▾

Default Value :zohosignCopied!

passwordstring(Optional)

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

Maximum Length :255Copied!

200 Document downloaded successfully.

▼ Show full