Download document from Zoho Sign

Table of Contents

Note:

  • Each time the zoho.sign.downloadDocument integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.sign.downloadDocument integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

The zoho.sign.downloadDocument task is used to download documents from Zoho Sign.

Syntax

<response> = zoho.sign.downloadDocument(<requestID>, [<connection>]);

where:

ParamsData TypeDescription
<response>FILEThe response returned by Zoho Sign which contains the downloaded file object.
<requestID>NUMBER

The request ID of the document that needs to be downloaded.

Note: You can get the ID of the Zoho Sign request from its URL. The URL is in the format: https://sign.zoho.com/zs#/request/new/<request_id>
(or)
You can get the request ID from the response of zoho.sign.uploadDocument task. Click here to learn how to fetch request ID from the response.

<connection>

(optional)*

TEXT

The name of the connection.

*Note: This param is not applicable to Zoho Creator and mandatory in Zoho Cliq.

Example

The following script downloads the specified document using its request ID:

response  = zoho.sign.downloadDocument(2131000000002069);

where:

response
The FILE response that represents the downloaded file.
2131000000002069
The NUMBER that represents the request ID of the document that needs to be downloaded.

Related Links