Update document
This will help you to update an existing document.
Arguments
Param | Datatype | Description |
|---|---|---|
| request_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 |
| 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/SMS] |
| verification_code | String | Verification Code required on in case of OFFLINE Verification type |
| 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. |
| Actions | JSON array |
Actions
Param | Datatype | Description |
|---|---|---|
| action_id | String | Action Id |
| 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 | APPROVER] |
| 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 |
| document_id | String | Document 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 number 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 |
API Root Endpoint
CopiedPUT https://sign.zoho.com/api/v1/requests/[Request Id]Request example
Copiedcurl --location --request PUT 'https://sign.zoho.com/api/v1/requests/14197000000767334' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={
"requests": {
"request_name": "NDA",
"actions": [
{
"action_id": "14197000000767351",
"recipient_name": "Alex James",
"recipient_email": "abc@example.com",
"action_type": "SIGN",
"fields": {
"check_boxes": [
{
"field_name": "Checkbox-1",
"field_label": "Checkbox",
"field_type_name": "Checkbox",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": true,
"is_read_only": false,
"description_tooltip": "You agree to this"
}
],
"text_fields": [
{
"field_name": "Textfield-1",
"field_label": "Textfield",
"field_type_name": "Textfield",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": "Text field - 1 default value",
"description_tooltip": "description of text field",
"text_property": {
"font_size": 15,
"font_color": "000000",
"font": "Liberation Serif",
"is_italic": true,
"is_underline": true,
"is_bold": true,
"is_read_only": true,
"is_fixed_width": false,
"is_fixed_height": true,
"max_field_length": 200
},
"name_format": "FULL_NAME",
"validation": {
"validation_type": "CUSTOM",
"validation_regex": ".*",
"validation_error_message": "Only Numbers are allowed in this field"
}
}
]
}
},
{
"action_id": "14197000000767356",
"action_type": "INPERSONSIGN",
"recipient_email": "xyz@example.com",
"recipient_name": "Alex James",
"in_person_name": "David",
"in_person_email": "david@example.com",
"fields": {
"image_fields": [
{
"field_name": "Signature",
"field_label": "Signature",
"field_type_name": "Signature",
"document_id": "14197000000767335",
"action_id": "14197000000767356",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"is_resizable": true,
"is_draggable": true,
"description_tooltip": "Add your signature"
}
]
}
}
]
}
}'Sample input
Copieddata={
"requests": {
"request_name": "NDA",
"actions": [
{
"action_id": "14197000000767351",
"recipient_name": "Alex James",
"recipient_email": "abc@example.com",
"action_type": "SIGN",
"fields": {
"check_boxes": [
{
"field_name": "Checkbox-1",
"field_label": "Checkbox",
"field_type_name": "Checkbox",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": true,
"is_read_only": false,
"description_tooltip": "You agree to this"
}
],
"text_fields": [
{
"field_name": "Textfield-1",
"field_label": "Textfield",
"field_type_name": "Textfield",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": "Text field - 1 default value",
"description_tooltip": "description of text field",
"text_property": {
"font_size": 15,
"font_color": "000000",
"font": "Liberation Serif",
"is_italic": true,
"is_underline": true,
"is_bold": true,
"is_read_only": true,
"is_fixed_width": false,
"is_fixed_height": true,
"max_field_length": 200
},
"name_format": "FULL_NAME",
"validation": {
"validation_type": "CUSTOM",
"validation_regex": ".*",
"validation_error_message": "Only Numbers are allowed in this field"
}
}
]
}
},
{
"action_id": "14197000000767356",
"action_type": "INPERSONSIGN",
"recipient_email": "xyz@example.com",
"recipient_name": "Alex James",
"in_person_name": "David",
"in_person_email": "david@example.com",
"fields": {
"image_fields": [
{
"field_name": "Signature",
"field_label": "Signature",
"field_type_name": "Signature",
"document_id": "14197000000767335",
"action_id": "14197000000767356",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"is_resizable": true,
"is_draggable": true,
"description_tooltip": "Add your signature"
}
]
}
}
]
}
}Response example
Copied{
"requests": {
"request_name": "NDA",
"actions": [
{
"action_id": "14197000000767351",
"recipient_name": "Alex James",
"recipient_email": "abc@example.com",
"action_type": "SIGN",
"fields": {
"check_boxes": [
{
"field_name": "Checkbox-1",
"field_label": "Checkbox",
"field_type_name": "Checkbox",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": true,
"is_read_only": false,
"description_tooltip": "You agree to this"
}
],
"text_fields": [
{
"field_name": "Textfield-1",
"field_label": "Textfield",
"field_type_name": "Textfield",
"document_id": "14197000000767335",
"action_id": "14197000000767351",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"default_value": "Text field - 1 default value",
"description_tooltip": "description of text field",
"text_property": {
"font_size": 15,
"font_color": "000000",
"font": "Liberation Serif",
"is_italic": true,
"is_underline": true,
"is_bold": true,
"is_read_only": true,
"is_fixed_width": false,
"is_fixed_height": true,
"max_field_length": 200
},
"name_format": "FULL_NAME",
"validation": {
"validation_type": "CUSTOM",
"validation_regex": ".*",
"validation_error_message": "Only Numbers are allowed in this field"
}
}
]
}
},
{
"action_id": "14197000000767356",
"action_type": "INPERSONSIGN",
"recipient_email": "xyz@example.com",
"recipient_name": "Alex James",
"in_person_name": "David",
"in_person_email": "david@example.com",
"fields": {
"image_fields": [
{
"field_name": "Signature",
"field_label": "Signature",
"field_type_name": "Signature",
"document_id": "14197000000767335",
"action_id": "14197000000767356",
"is_mandatory": true,
"x_coord": 50,
"y_coord": 50,
"abs_width": 50,
"abs_height": 50,
"page_no": 0,
"is_resizable": true,
"is_draggable": true,
"description_tooltip": "Add your signature"
}
]
}
}
]
}
}