Sign Document.V2

Table of Contents

Note:

  • Applicable to all services except Zoho Creator
  • Each time the zoho.writer.v2.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.v2.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. 

Description

The zoho.writer.v2.signDocument task sends a document for signature and tracks its status. This task is based on the Zoho Writer Sign API.

Syntax

<response> = zoho.writer.v2.signDocument(<document_id>, <recipients_list>, <signed_document_name>, <optional_settings>,<connection>);
ParamsData typeDescription
<response>KEY-VALUE                                The response returned by Zoho Writer. It provides the signing status along with the signing status URL.
<document_id>TEXT                                The ID of the document to be sent for signature.
The document ID can be obtained from the document URL, which is formatted as follows:
https://writer.zoho.com/writer/open/<document_id>
<recipients_list>[
{
"recipient_1": "john@zylker.com",
"recipient_name": "John",
"action_type": <approve|sign|view|in_person_sign>,
"language": "en”,
“private_notes”: “Hey! Please sign this document”
},
{
 "recipient_2": "amelia@zylker.com",
 "recipient_name": "Amelia",
"action_type": <approve|sign|view|in_person_sign>,
"language": "fr",
“verification_info": {
"type": <email|sms|offline>
 }
},
...
]		Recipients who must sign the document in person or online, approved or viewed in the form of a JSON array.
You can choose the language in which the notification email will be sent to signers. It is possible to verify and provide private notes to recipients.
Supported languages are: Chinese(zh), Dutch(nl), English(en), French(fr), German(de), Italian(it), Japanese(ja), Polish(pl), Portuguese(pt), Russian(ru), Spanish(es), Swedish(sv).
You can refer to a sample JSON array here.
<signed_document_name>

 String

A name for the signed document.
<optional_settings>KEY-VALUE                                The optional parameters you can apply to receive a signature according to your preference.
<connection>TEXT                                

The connection's link name.

 

Note:

  • To prevent new authtoken generation and ensure new integration tasks (created after the deadline specified in the post) work as expected, a Zoho OAuth connection with appropriate scopes is mandatory. Existing integration tasks will continue to work, with or without the connections parameter, until you manually delete the authtoken from Zoho Accounts.

  • Add relevant scopes from the Zoho Writer API when creating the connection.

  • Refer to this post for a list of Zoho services that support the Connections page.

Learn more about connections

Recipients

ParameterTypePossible ValuesDefault Value
recipient_nString

recipient_1, recipient_2, ... , recipient_10

Note: A maximum of 10 recipients are currently supported.

john@zylker.com
action_typeStringapprove/sign/view/in_person_sign  sign
languageStringzh / nl / en / fr / de / it / ja / pl / pt / ru / es / svThis option is only available to Zoho Sign Premium Plan users.
If you are a 
Free Plan user, the notification email will be sent in your default account language.

<optional_settings>

ParameterTypePossible values
subjectStringThe subject of the email.
messageStringContent for the email body.
attachmentsFile Object Any attachments to the email (maximum of 3 files can be attached).
is_sequentialtrue / falseThe order in which document singing or approval must take place.
reminder_periodIntegerA reminder for signing or approving the document every 'n' days.
expire_inIntegerThe document expiry date.

Example

The following script sends a document for signature collection.

document_id = "f1nb************63d72";
                                signed_document_name = "Signed_document";
                                recipients_list = List();
                                recipients_map_1 = Map();
                                recipients_map_1.put("recipient_1","john@zylker.com");
                                recipients_map_1.put("recipient_name","john");
                                recipients_map_1.put("action_type","approve");
                                recipients_map_1.put("language","en");
                                recipients_list.add(recipients_map_1);
                                downloadFile1 = invokeurl
                                [
                                url :"https://www.africau.edu/images/default/sample.pdf"
                                type :GET
                                ];
                                downloadFile2 = invokeurl
                                [
                                url :"https://www.africau.edu/images/default/sample.pdf"
                                type :GET
                                ];
                                attachments_list = List();
                                attachments_list.add(downloadFile1);
                                attachments_list.add(downloadFile2);
                                optional_settings = Map();
                                optional_settings.put("attachments",attachments_list);
                                optional_settings.put("subject","Reg Document Sign");
                                optional_settings.put("message","Please find the document to be signed here");
                                optional_settings.put("is_sequential","true");
                                optional_settings.put("reminder_period","1");
                                optional_settings.put("expire_in","2");
                                response = zoho.writer.v2.signDocument(document_id,recipients_list,signed_document_name,optional_settings,"writerconnection");
                                info response;

Response Format

Success Response:

The success response will be returned in the following format:

{
"status": success, //or failed
"sign_status_url": <URL>
}

Related Links