Zoho Writer sign document

Table of Contents

Note:

  • Each time the zoho.writer.signDocument 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.writer.signDocument 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.writer.signDocument task sends an email to get a document signed by the specified recipients.

This integration task is based on the Zoho Writer - Sign API.

Syntax

<response> = zoho.writer.signDocument(<document_id>, <service>, <recipients>, <signed_document_name>, <input_map>, <connection>);

where:

ParamsData typeDescription
<response>KEY-VALUEThe response returned by Zoho Writer that represents the status of the task.
<document_id>TEXT

The ID of the document that will be sent for signing.

Note: You can get the ID of the document for its URL. The URL is in the format: https://writer.zoho.com/writer/open/<document_id>

<service>TEXT

The name of the service using which you want the document to be signed.

Allowed values:

  • zohosign

 

<recipients>TEXT/ LISTThe email address of the recipients who will sign the document.
<signed_document_name>TEXTNew name for the signed document
<inpu_map>KEY-VALUE

Other information that can be provided to send a document for signing.

Note: The keys of this parameter should be specified as given in the Zoho Writer - Sign API.

<connection>TEXT

The link name of the connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory in order for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter until you manually delete the authtoken from accounts.
  • Add relevant scopes mentioned in Zoho Writer API while creating the connection.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Example

The following script sends the specified Sign document as emails to the mentioned recipients list. 

 recipient1 = Map();
 recipient1.put("recipient_1", "shawn@zylker.com");
 recipient1.put("recipient_name", "Shawn");
 recipient1.put("action_type", "sign");
 
 recipient2 = Map();
 recipient2.put("recipient_2","kate@zylker.com");
 recipient2.put("recipient_name", "Kate");
 recipient2.put("action_type", "approve");
 
 recipient3 = Map();
 recipient3.put("recipient_3","robin@zylker.com");
 recipient3.put("recipient_name", "Robin");
 recipient3.put("action_type", "view");
 
 email = List();
 email.put(recipient1);
 email.put(recipient2);
 email.put(recipient3);
 
 inputMap = Map();
 inputMap.put("subject", "Document to sign");
 inputMap.put("message", "Please verify and sign the document");
 
 response=zoho.writer.signDocument("3z7frc3fda95142ef45fbb9aadf220632b1d6", "zohosign", email, "Signed Document", inputMap, "writer_oauth_connection");

where:

response
The KEY-VALUE response that represents the status of the executed task.
"3z7frc3fda95142ef45fbb9aadf220632b1d6"
The TEXT that represents the ID of the Zoho Writer document.
"zohosign"
The TEXT  that represents the service using which the document needs to be signed.
email
The LIST variable that holds the recipients of the email.
"Signed Document"
The TEXT that represents the new name for the signed document.
inputMap
The KEY-VALUE variable that holds the input parameters like subject and message of the email.
"action_type"
The TEXT key as mentioned in the Zoho People API used to specify what kind of action the recipient can perform on the document.

Success Response

  • The success response will be returned in the following format:

     {
     "sign_status_url": "https://sign.zoho.com/zs#/request/details/10696XXXXXXX43001",
     "status": "success"
     }

Failure Response

  • The failure response for incorrect or unauthorized document ID will be returned in the following format:

     {
     "error": {
     "message": "Permission denied. You are not authorized to perform this operation.",
     "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
     "response_generated_time": 1588244128206,
     "request_url": "https://writerinteg1.zoho.com/writer/api/v1/documents/3z7frc3fda9542ef45fbb9aadf220632b1d6/sign",
     "errorcode": "R5010"
     }
     }

  • The failure response for missing mandatory parameter will be returned in the following format:

    {
     "error": {
     "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
     "message": "One or more mandatory parameters are missing. Please try again with all required parameters.",
     "errorcode": "R6001"
     }
     }

Related Links