Zoho Writer sign document
Table of Contents
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:
Params | Data type | Description |
<response> | KEY-VALUE | The 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:
|
<recipients> | TEXT/ LIST | The email address of the recipients who will sign the document. |
<signed_document_name> | TEXT | New 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:
|
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
"3z7frc3fda95142ef45fbb9aadf220632b1d6"
"zohosign"
email
"Signed Document"
inputMap
"action_type"
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"
}
}