How can I merge documents and send them for signature?
You can merge existing templates or documents and send them out for signature.
- An API call is passed to check if the documents can be merged and sent for signature. If the documents can be merged, you will receive the merged output along with the receipient's information.
- The recipient section will contain the merged variable like $RECI_NAME_0$, $reci_email_0$, which must be replaced with the actual value.
- Once the documents are merged, you can use the update document and submit document APIs to perform actions accordingly.
- You can merge templates to an existing document in draft.
API endpoint
Copiedhttps://sign.zoho.com/api/v1/requests/mergewithtemplatesSample request
Copiedtemplate_ids : ["<template_id1>","<template_id2>"]
request_id : "<request_id>"
data : {"requests":{"deleted_actions":[],"request_name":"Rental Agreement"}}
org_id : <org_id>Sample response
Copied{
"code": 0,
"requests": {
"request_status": "draft",
"notes": "",
"reminder_period": 5,
"owner_id": "123456789098",
"description": "",
"request_name": "Rental Agreement",
"modified_time": 1753162160001,
"is_deleted": false,
"expiration_days": 15,
"is_sequential": true,
"templates_used": [],
"owner_first_name": "John",
"sign_percentage": 0,
"owner_email": "john.smith@zylker.com",
"created_time": 1753162116423,
"email_reminders": true,
"document_ids": [
{
"document_name": "Rental Agreement",
"pages": [
{
"image_string": "<base64 string>",
"page": 0,
"is_thumbnail": true
}
],
"document_size": 16531,
"document_order": "0",
"is_nom151_present": false,
"is_editable": false,
"total_pages": 3,
"document_id": "66142000001484002"
},
{
"document_name": "New Document",
"pages": [
{
"image_string": "<base64 string>",
"page": 0,
"is_thumbnail": true
}
],
"document_size": 15330,
"document_order": "1",
"is_nom151_present": false,
"is_editable": false,
"total_pages": 3,
"document_id": "66142000001484023"
}
],
"self_sign": false,
"document_fields": [
{
"document_id": "66142000001484002",
"fields": []
},
{
"document_id": "66142000001484023",
"fields": [
{
"field_id": "66142000001484039",
"x_coord": 364,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Landlord Address",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Landlord Address",
"y_value": 14.979554,
"abs_width": 127,
"width": 20.721046,
"y_coord": 119,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 59.532207,
"height": 2.405556
},
{
"field_id": "66142000001484040",
"x_coord": 345,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Tenant Address",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Tenant Address",
"y_value": 17.158052,
"abs_width": 117,
"width": 19.051317,
"y_coord": 136,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 56.336983,
"height": 2.405556
},
{
"field_id": "66142000001484041",
"x_coord": 244,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Property Address",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Property Address",
"y_value": 26.723585,
"abs_width": 125,
"width": 20.477444,
"y_coord": 212,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 39.878063,
"height": 2.405556
},
{
"field_id": "66142000001484042",
"x_coord": 313,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Lease Term",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Lease Term",
"y_value": 34.11124,
"abs_width": 96,
"width": 15.623848,
"y_coord": 270,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 51.12519,
"height": 2.40556
},
{
"field_id": "66142000001484043",
"x_coord": 72,
"field_type_id": "66142000000061001",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "datefield",
"is_disabled": false,
"field_label": "Start Date",
"is_hidden": false,
"is_mandatory": false,
"time_zone_offset": 330,
"page_no": 0,
"document_id": "66142000001484023",
"time_zone": "Asia/Kolkata",
"field_name": "Start Date",
"y_value": 36.29008,
"abs_width": 138,
"width": 22.53609,
"y_coord": 287,
"date_format": "dd MMM yyyy",
"field_type_name": "CustomDate",
"description_tooltip": "",
"x_value": 11.76663,
"height": 2.405556
},
{
"field_id": "66142000001484044",
"x_coord": 291,
"field_type_id": "66142000000061001",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "datefield",
"is_disabled": false,
"field_label": "End Date",
"is_hidden": false,
"is_mandatory": false,
"time_zone_offset": 330,
"page_no": 0,
"document_id": "66142000001484023",
"time_zone": "Asia/Kolkata",
"field_name": "End Date",
"y_value": 36.29008,
"abs_width": 132,
"width": 21.604755,
"y_coord": 287,
"date_format": "dd MMM yyyy",
"field_type_name": "CustomDate",
"description_tooltip": "",
"x_value": 47.600388,
"height": 2.405556
},
{
"field_id": "66142000001484045",
"x_coord": 295,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Monthly Rent",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Monthly Rent",
"y_value": 48.033768,
"abs_width": 103,
"width": 16.870342,
"y_coord": 380,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 48.26912,
"height": 2.405556
},
{
"field_id": "66142000001484046",
"x_coord": 92,
"field_type_id": "66142000000061001",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "datefield",
"is_disabled": false,
"field_label": "Due Date",
"is_hidden": false,
"is_mandatory": false,
"time_zone_offset": 330,
"page_no": 0,
"document_id": "66142000001484023",
"time_zone": "Asia/Kolkata",
"field_name": "Due Date",
"y_value": 50.21261,
"abs_width": 133,
"width": 21.714138,
"y_coord": 398,
"date_format": "dd MMM yyyy",
"field_type_name": "CustomDate",
"description_tooltip": "",
"x_value": 15.006544,
"height": 2.405556
},
{
"field_id": "66142000001484047",
"x_coord": 327,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Late Fee Amount",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Late Fee Amount",
"y_value": 52.390762,
"abs_width": 124,
"width": 20.203678,
"y_coord": 415,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 53.506447,
"height": 2.405556
},
{
"field_id": "66142000001484048",
"x_coord": 406,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Security Deposit",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Security Deposit",
"y_value": 61.956295,
"abs_width": 120,
"width": 19.537952,
"y_coord": 491,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 66.279366,
"height": 2.405556
},
{
"field_id": "66142000001484049",
"x_coord": 72,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Security Deposit Return Period",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 0,
"document_id": "66142000001484023",
"field_name": "Security Deposit Return Period",
"y_value": 68.49179,
"abs_width": 195,
"width": 31.858019,
"y_coord": 542,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 11.76663,
"height": 2.405554
},
{
"field_id": "66142000001484050",
"x_coord": 155,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "List of Utilities Landlord is Responsible for, if any",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 1,
"document_id": "66142000001484023",
"field_name": "List of Utilities Landlord is Responsible for, if any",
"y_value": 25.208565,
"abs_width": 291,
"width": 47.50599,
"y_coord": 200,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 25.299253,
"height": 2.405556
},
{
"field_id": "66142000001484051",
"x_coord": 330,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "Termination Notice Period",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 1,
"document_id": "66142000001484023",
"field_name": "Termination Notice Period",
"y_value": 56.08428,
"abs_width": 172,
"width": 28.120064,
"y_coord": 444,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 53.852783,
"height": 2.405556
},
{
"field_id": "66142000001484052",
"x_coord": 72,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "State/Country",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 1,
"document_id": "66142000001484023",
"field_name": "State/Country",
"y_value": 72.1853,
"abs_width": 107,
"width": 17.54476,
"y_coord": 572,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 11.76663,
"height": 2.405554
},
{
"field_id": "66142000001484053",
"x_coord": 123,
"field_type_id": "66142000000000147",
"abs_height": 19,
"text_property": {
"is_italic": false,
"max_field_length": 2048,
"is_underline": false,
"font_color": "000000",
"is_fixed_width": false,
"font_size": 10,
"is_fixed_height": true,
"is_read_only": false,
"alignment": "LEFT",
"is_bold": false,
"font": "Roboto"
},
"field_category": "textfield",
"is_disabled": false,
"field_label": "State/Country",
"is_hidden": false,
"is_mandatory": false,
"default_value": "",
"page_no": 1,
"document_id": "66142000001484023",
"field_name": "State/Country",
"y_value": 74.36381,
"abs_width": 107,
"width": 17.550411,
"y_coord": 589,
"field_type_name": "Textfield",
"description_tooltip": "",
"x_value": 20.120977,
"height": 2.405554
}
]
}
],
"template_ids": [
"<template_id>"
],
"allow_add_comments": true,
"in_process": false,
"validity": -1,
"request_type_name": "Others",
"visible_sign_settings": {
"visible_sign": false,
"allow_reason_visible_sign": false
},
"request_id": "66142000001484001",
"request_type_id": "66142000000000135",
"owner_last_name": "Smith",
"actions": [
{
"verify_recipient": false,
"recipient_countrycode_iso": "",
"action_type": "SIGN",
"private_notes": "",
"cloud_provider_name": "Zoho Sign",
"recipient_email": "$reci_email_0$",
"send_completed_document": true,
"recipient_phonenumber": "",
"is_bulk": false,
"action_id": "66142000001484055",
"signing_order": 1,
"cloud_provider_id": 10,
"recipient_name": "$RECI_NAME_0$",
"fields": [
{
"field_id": "66142000001484058",
"x_coord": 74,
"field_type_id": "66142000000000141",
"abs_height": 19,
"field_category": "image",
"field_label": "Signature",
"is_mandatory": true,
"page_no": 2,
"document_id": "66142000001484023",
"is_draggable": false,
"field_name": "Signature",
"y_value": 13.585241,
"abs_width": 135,
"action_id": "66142000001484055",
"width": 22.06333,
"y_coord": 108,
"field_type_name": "Signature",
"description_tooltip": "",
"x_value": 12.118552,
"is_resizable": true,
"height": 2.446725
}
],
"delivery_mode": "EMAIL",
"action_status": "NOACTION",
"is_signing_group": false,
"recipient_countrycode": ""
},
{
"verify_recipient": false,
"recipient_countrycode_iso": "",
"action_type": "SIGN",
"private_notes": "",
"cloud_provider_name": "Zoho Sign",
"recipient_email": "$reci_email_1$",
"send_completed_document": true,
"recipient_phonenumber": "",
"is_bulk": false,
"action_id": "66142000001484060",
"signing_order": 2,
"cloud_provider_id": 10,
"recipient_name": "$RECI_NAME_1$",
"fields": [
{
"field_id": "66142000001484063",
"x_coord": 301,
"field_type_id": "66142000000000141",
"abs_height": 19,
"field_category": "image",
"field_label": "Signature",
"is_mandatory": true,
"page_no": 2,
"document_id": "66142000001484023",
"is_draggable": false,
"field_name": "Signature",
"y_value": 13.587091,
"abs_width": 135,
"action_id": "66142000001484060",
"width": 22.06333,
"y_coord": 108,
"field_type_name": "Signature",
"description_tooltip": "",
"x_value": 49.193214,
"is_resizable": true,
"height": 2.446725
}
],
"delivery_mode": "EMAIL",
"action_status": "NOACTION",
"is_signing_group": false,
"recipient_countrycode": ""
}
]
},
"message": "Document has been updated",
"status": "success"
}