Update template
This will help you to update an existing template.
ARGUMENTS
Param | Datatype | Description |
|---|---|---|
| template_name * | String | name to be given to the signature request |
| request_type_id | String | Document Category Id |
| notes | String | Message to be sent to all recipients in common |
| expiration_days | Int | No of days after which the document will expire. |
| is_sequential * | Boolean | Sequential signing / Parallel Signing[true/false] |
| email_reminders | Boolean | Send automatic reminders |
| reminder_period | Int | Send automatic reminders once in [n] days |
| folder_id | String | Folder |
| role * | String | Role of the recipient |
| recipient_name * | String | Recipient name |
| recipient_email * | String | Recipient email |
| in_person_name * | String | Inperson recipient name |
| in_person_email | String | Inperson recipient email |
| action_type * | String | Recipient Action [SIGN | VIEW | INPERSONSIGN] |
| private_notes | String | Private notes for each recipient |
| signing_order | Int | Order in which recipient actions needs to be performed |
| verify_recipient * | Boolean | Authentication needs to be done or not |
| verification_type | String | Verification Mode [EMAIL/OFFLINE] |
| document_id | String | Document Id |
| actions | JSON array |
Actions
Param | Datatype | Description |
|---|---|---|
| action_id | String | Action Id |
| is_mandatory | Boolean | If the field is mandatory or optional |
| x_coord | Int | X coordinate of the field |
| y_coord | Int | Y coordinate of the field |
| abs_width | Int | Width of the field |
| abs_height | Int | Height of the field |
| page_no | Int | Page no where the field is placed |
| default_value | String | default value for a field |
| is_read_only | Boolean | To specify if checkbox is read_only or not |
| name_format | String | Name Format [FIRST_NAME|LAST_NAME|FULL_NAME] |
| date_format | String | Date Format |
| description_tooltip | String | Description about the field |
| font_size | Boolean | Font Size |
| font_color | Boolean | Font Color (Hex Code #000000) |
| font | String | Font Name |
| is_italic | Boolean | Italic |
| is_bold | Boolean | Bold |
| is_read_only | Boolean | If a field only or not for text fields. |
| Fields | JSON object |
Fields
Param | Datatype | Description |
|---|---|---|
| field_name | String | Field name |
| field_id | String | Field Id |
| field_label | String | Label of field |
| field_type_name | String | Checkbox|Radiogroup|Signature|Initial|Textfield| Email|Date|Name|Company|Jobtitle|CustomDate|Dropdown |
API Root Endpoint
PUT https://sign.zoho.com/api/v1/templates/[Template Id]Request example
$ curl https://sign.zoho.com/api/v1/requests/[Template Id] \
-X PUT \
-H "Authorization: Zoho-oauthtoken <Oauth Token>" \
-d 'data={
"templates": {
"document_fields": [
{
"fields": {
"image_fields": [
{
"field_type_name": "Signature",
"field_name": "Signature",
"document_id": "2000000493029",
"is_mandatory": true,
"page_no": 0,
"x_coord": 17,
"y_coord": 12,
"abs_width": 22,
"abs_height": 5
},
{
"field_type_name": "Initial",
"field_name": "Initial",
"document_id": "2000000493029",
"is_mandatory": true,
"page_no": 0,
"x_coord": 59,
"y_coord": 14,
"abs_width": 8,
"abs_height": 5
}
],
"date_fields": [],
"check_boxes": [],
"radio_groups": [],
"text_fields": []
},
"document_id": "2000000493029",
"deleted_fields": []
}
],
"actions": [
{
"action_id": "2000000493038",
"action_type": "SIGN",
"signing_order": 0,
"recipient_name": "",
"role": "1",
"recipient_email": "",
"recipient_phonenumber": "",
"recipient_countrycode": "",
"private_notes": "Please get back to us for further queries",
"verify_recipient": true,
"verification_type": "EMAIL",
"deleted_fields": [],
"deleted_radio_fields": [],
"fields": {
"text_fields": [
{
"field_type_name": "Company",
"field_name": "Company",
"document_id": "2000000493029",
"is_mandatory": true,
"page_no": 0,
"x_coord": 31,
"y_coord": 1,
"abs_width": 16,
"abs_height": 5,
"text_property": {
"font": "Arial",
"font_size": 11,
"font_color": "000000",
"is_bold": false,
"is_italic": false
}
},
{
"field_type_name": "Email",
"field_name": "Email",
"document_id": "2000000493029",
"is_mandatory": true,
"page_no": 0,
"x_coord": 56,
"y_coord": 1,
"abs_width": 31,
"abs_height": 5,
"text_property": {
"font": "Arial",
"font_size": 11,
"font_color": "000000",
"is_bold": false,
"is_italic": false
}
}
],
"image_fields": [
{
"field_type_name": "Signature",
"field_name": "Signature",
"document_id": "2000000493029",
"is_mandatory": true,
"page_no": 0,
"x_coord": 2,
"y_coord": 1,
"abs_width": 22,
"abs_height": 5
}
],
"date_fields": [],
"check_boxes": [
{
"field_type_name": "Checkbox",
"field_name": "Checkbox_1",
"document_id": "2000000493029",
"is_mandatory": false,
"page_no": 0,
"x_coord": 50,
"y_coord": 1,
"abs_width": 20,
"abs_height": 5,
"default_value": false
}
],
"radio_groups": []
}
}
]
}
}'Show full
Show less
Response example
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
"code": 0,
"templates": {
"owner_email": "v****@***.com",
"created_time": 1522746328987,
"email_reminders": false,
"document_ids": [
{
"image_string": "<BASE 64 Image String>",
"document_name": "4page170kbsquared file testrotated.pdf",
"pages": [
{
"image_string": "<BASE 64 Image String>",
"page": 0,
"is_thumbnail": true
}
],
"document_size": 174307,
"document_order": "0",
"total_pages": 4,
"document_id": "2000000493029"
}
],
"notes": "",
"reminder_period": 8,
"owner_id": "2000000002002",
"document_fields": [
{
"document_id": "2000000493029",
"fields": [
{
"field_id": "2000000493047",
"field_category": "image",
"field_label": "Signature",
"is_mandatory": true,
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Signature",
"y_coord": 12,
"abs_width": 22,
"field_type_name": "Signature",
"description_tooltip": "",
"x_coord": 17,
"abs_height": 5
},
{
"field_id": "2000000493048",
"field_category": "image",
"field_label": "Initial",
"is_mandatory": true,
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Initial",
"y_coord": 14,
"abs_width": 18,
"field_type_name": "Initial",
"description_tooltip": "",
"x_coord": 59,
"abs_height": 5
}
]
}
],
"description": "",
"template_name": "Template 1",
"modified_time": 1522746467719,
"is_deleted": false,
"expiration_days": 1,
"is_sequential": true,
"template_id": "2000000493035",
"request_type_name": "Others",
"owner_first_name": "V*******",
"request_type_id": "2000000000135",
"owner_last_name": "",
"actions": [
{
"verify_recipient": true,
"role": "1",
"action_id": "2000000493038",
"action_type": "SIGN",
"private_notes": "Please get back to us for further queries",
"recipient_email": "",
"signing_order": 0,
"verification_type": "EMAIL",
"fields": [
{
"field_id": "2000000493043",
"field_category": "checkbox",
"field_label": "Checkbox_1",
"is_mandatory": false,
"default_value": false,
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Checkbox_1",
"y_coord": 1,
"action_id": "2000000493038",
"abs_width": 20,
"is_read_only": false,
"field_type_name": "Checkbox",
"description_tooltip": "",
"x_coord": 50,
"abs_height": 5
},
{
"field_id": "2000000493044",
"text_property": {
"is_italic": false,
"is_underline": false,
"font_color": "000000",
"font_size": 11,
"is_read_only": false,
"is_bold": false,
"font": "Arial"
},
"field_category": "textfield",
"field_label": "Company",
"is_mandatory": true,
"default_value": "",
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Company",
"y_coord": 1,
"action_id": "2000000493038",
"abs_width": 16,
"field_type_name": "Company",
"description_tooltip": "",
"x_coord": 31,
"abs_height": 5
},
{
"field_id": "2000000493045",
"text_property": {
"is_italic": false,
"is_underline": false,
"font_color": "000000",
"font_size": 11,
"is_read_only": false,
"is_bold": false,
"font": "Arial"
},
"field_category": "textfield",
"field_label": "Email",
"is_mandatory": true,
"default_value": "",
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Email",
"y_coord": 1,
"action_id": "2000000493038",
"abs_width": 31,
"field_type_name": "Email",
"description_tooltip": "",
"x_coord": 56,
"abs_height": 5
},
{
"field_id": "2000000493046",
"field_category": "image",
"field_label": "Signature",
"is_mandatory": true,
"page_no": 0,
"document_id": "2000000493029",
"field_name": "Signature",
"y_coord": 1,
"action_id": "2000000493038",
"abs_width": 22,
"field_type_name": "Signature",
"description_tooltip": "",
"x_coord": 2,
"abs_height": 5
}
],
"recipient_name": "",
"recipient_phonenumber": "",
"recipient_countrycode": ""
}
]
},
"status": "success"
}Show full
Show less