Zoho Sign
Zoho's Sign is a complete digital signature app that helps digitally sign business documents with complete security and reliability
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Zoho Sign API Support |
| URL | https://www.zoho.com/sign/contact.html |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Zoho Corporation |
| Website | https://www.zoho.com/sign/ |
| Privacy policy | https://www.zoho.com/privacy.html |
| Categories | Content and Files;Productivity |
Digitally sign business documents online with complete security and reliability using Zoho's e-signature software. Automate your transactions with simple e-sign document workflows. A complete digital signature app for business signatories.
Prerequisites
In order to use this connector you must have paid for Zoho-Sign account on the Zoho-Sign platform. For details refer https://www.zoho.com/sign/pricing-api.html You can also set up an account here https://zoho.com/sign ##How to get credentials The Zoho-Sign API uses OAuth 2 to authenticate. So once account is setup no additional steps are required.
All Zoho Sign APIs require this mandatory header: Authorization - Authentication request header.
For token generations refer: https://www.zoho.com/sign/api/#getting-started
Get started with your connector
Zoho Sign Connector provides the option for users to perform document management, template management, and other operations directly, without accessing Zoho Sign’s web interface
Under document manager, using these connectors, users can create documents, update documents, send documents out for signatures and get a list of all documents related to your account.
Similarly for other operations, refer to the "WHAT ARE THE SUPPORTED OPERATIONS?" title in the below link,
https://www.zoho.com/sign/api/#introduction
These connectors will help you automate the usage, right from the document or template sending to status tracking and more.
Common errors and remedies
In case of an error, debug it with the proper error codes and their reason.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Select the region. | string | Select the domain. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a document for signing |
An action to create a document for signing by uploading a file. |
| Delete Document |
Delete a particular document |
| Download Completion Certificate |
Downloads the completion certificate of a specific envelope |
| Download Document |
Downloads a specific envelope |
| Download File |
Downloads a specific document or file |
| Get a document |
Shows the details of a specific envelope |
| Get data of completed request |
Shows the details of a signed envelope |
| Get list of templates |
Shows a list of all the document templates created |
| Get particular template details |
Shows the details of a specific document template |
| Invoke API |
Invoke API |
| Recall a particular document |
Recall a particular document |
| Reminder for recipients |
Send a reminder to recipients of a particular document. |
|
Send |
Send the uploaded document out for signature |
| Update the properties of a created request |
Update the properties of a created request |
Create a document for signing
An action to create a document for signing by uploading a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
create a document
|
file | True | file |
create a document |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
request_status
|
requests.request_status | string |
Status of the request |
|
owner_email
|
requests.owner_email | string |
Owner email |
|
created_time
|
requests.created_time | integer |
Created time |
|
document_ids
|
requests.document_ids | array of object |
document_ids |
|
image_string
|
requests.document_ids.image_string | string |
Image string |
|
document_name
|
requests.document_ids.document_name | string |
Document name |
|
pages
|
requests.document_ids.pages | array of object |
pages |
|
image_string
|
requests.document_ids.pages.image_string | string |
Image string |
|
page
|
requests.document_ids.pages.page | integer |
page |
|
is_thumbnail
|
requests.document_ids.pages.is_thumbnail | boolean |
is_thumbnail |
|
document_size
|
requests.document_ids.document_size | integer |
Document size |
|
document_order
|
requests.document_ids.document_order | string |
Document order |
|
total_pages
|
requests.document_ids.total_pages | integer |
Total pages |
|
document_id
|
requests.document_ids.document_id | string |
Document id |
|
notes
|
requests.notes | string |
notes |
|
self_sign
|
requests.self_sign | boolean |
self sign |
|
owner_id
|
requests.owner_id | string |
owner id |
|
description
|
requests.description | string |
Description |
|
folder_name
|
requests.folder_name | string |
Folder name |
|
request_name
|
requests.request_name | string |
Request Name |
|
modified_time
|
requests.modified_time | integer |
modified time |
|
is_deleted
|
requests.is_deleted | boolean |
Status of deletion |
|
expiration_days
|
requests.expiration_days | integer |
Expiration days |
|
in_process
|
requests.in_process | boolean |
In process |
|
is_sequential
|
requests.is_sequential | boolean |
Sequential status |
|
request_type_name
|
requests.request_type_name | string |
Request type name |
|
owner_first_name
|
requests.owner_first_name | string |
Owner first name |
|
folder_id
|
requests.folder_id | string |
Folder id |
|
request_id
|
requests.request_id | string |
Request id |
|
request_type_id
|
requests.request_type_id | string |
Request type id |
|
owner_last_name
|
requests.owner_last_name | string |
Owner Last name |
|
sign_percentage
|
requests.sign_percentage | integer |
Sign percentage |
|
message
|
message | string |
Message |
|
status
|
status | string |
status |
Delete Document
Delete a particular document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
Download Completion Certificate
Downloads the completion certificate of a specific envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
Returns
- response
- file
Download Document
Downloads a specific envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
Returns
- response
- file
Download File
Downloads a specific document or file
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
|
Document ID
|
document_id | True | integer |
Document ID |
Returns
- response
- file
Get a document
Shows the details of a specific envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
RequestId | True | integer |
Request ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
request_status
|
requests.request_status | string |
Status of the request |
|
notes
|
requests.notes | string |
Notes |
|
attachments
|
requests.attachments | array of |
Attachments |
|
reminder_period
|
requests.reminder_period | integer |
Reminder period |
|
owner_id
|
requests.owner_id | string |
Owner ID |
|
description
|
requests.description | string |
Description of the request |
|
request_name
|
requests.request_name | string |
Name of the request |
|
modified_time
|
requests.modified_time | integer |
Modified Time |
|
action_time
|
requests.action_time | integer |
Action Time |
|
is_deleted
|
requests.is_deleted | boolean |
Delete status of the request |
|
expiration_days
|
requests.expiration_days | integer |
Expiration days |
|
is_sequential
|
requests.is_sequential | boolean |
Sequential Status |
|
sign_submitted_time
|
requests.sign_submitted_time | integer |
Sign submitted time |
|
owner_first_name
|
requests.owner_first_name | string |
First Name of the owner |
|
sign_percentage
|
requests.sign_percentage | float |
Sign percentage |
|
expire_by
|
requests.expire_by | integer |
Expiry Date of the Document |
|
is_expiring
|
requests.is_expiring | boolean |
Document expiring on |
|
owner_email
|
requests.owner_email | string |
Email ID of the owner |
|
created_time
|
requests.created_time | integer |
Time when the document was created |
|
email_reminders
|
requests.email_reminders | boolean |
Sending reminders via email |
|
document_ids
|
requests.document_ids | array of object |
Document Ids |
|
image_string
|
requests.document_ids.image_string | string |
Image string |
|
document_name
|
requests.document_ids.document_name | string |
Document Name |
|
pages
|
requests.document_ids.pages | array of object |
pages |
|
image_string
|
requests.document_ids.pages.image_string | string |
Image string |
|
page
|
requests.document_ids.pages.page | integer |
page |
|
is_thumbnail
|
requests.document_ids.pages.is_thumbnail | boolean |
Status of thumbnail |
|
document_size
|
requests.document_ids.document_size | integer |
Size of the document |
|
document_order
|
requests.document_ids.document_order | string |
Document order |
|
total_pages
|
requests.document_ids.total_pages | integer |
Total No.of pages in the document |
|
document_id
|
requests.document_ids.document_id | string |
Document Id |
|
self_sign
|
requests.self_sign | boolean |
Self sign status |
|
sign_id
|
requests.sign_id | string |
Sign id |
|
folder_name
|
requests.folder_name | string |
Name of the folder |
|
in_process
|
requests.in_process | boolean |
In process status |
|
validity
|
requests.validity | integer |
Validity of the document |
|
request_type_name
|
requests.request_type_name | string |
Request type name |
|
folder_id
|
requests.folder_id | string |
Folder id |
|
request_id
|
requests.request_id | string |
Request Id |
|
request_type_id
|
requests.request_type_id | string |
Request type id |
|
owner_last_name
|
requests.owner_last_name | string |
Last Name of the owner |
|
actions
|
requests.actions | array of object |
actions |
|
verify_recipient
|
requests.actions.verify_recipient | boolean |
Verify Recipients Mail ID |
|
action_type
|
requests.actions.action_type | string |
Action type |
|
private_notes
|
requests.actions.private_notes | string |
Private notes |
|
recipient_email
|
requests.actions.recipient_email | string |
Recipient's Email ID |
|
send_completed_document
|
requests.actions.send_completed_document | boolean |
Status of send completed document |
|
verification_type
|
requests.actions.verification_type | string |
Verification type |
|
allow_signing
|
requests.actions.allow_signing | boolean |
Allow signing status |
|
recipient_phonenumber
|
requests.actions.recipient_phonenumber | string |
Recipient phonenumber |
|
is_bulk
|
requests.actions.is_bulk | boolean |
Status of bulk |
|
action_id
|
requests.actions.action_id | string |
Action id |
|
is_revoked
|
requests.actions.is_revoked | boolean |
Status of revoke |
|
is_embedded
|
requests.actions.is_embedded | boolean |
Status of embedded |
|
signing_order
|
requests.actions.signing_order | integer |
Signing order |
|
recipient_name
|
requests.actions.recipient_name | string |
Recipient name |
|
action_status
|
requests.actions.action_status | string |
Action status |
|
recipient_countrycode
|
requests.actions.recipient_countrycode | string |
Recipient countrycode |
|
ishost
|
requests.actions.ishost | boolean |
host usage status |
|
language
|
requests.actions.language | string |
language |
|
in_person_name
|
requests.actions.in_person_name | string |
In person name |
|
in_person_email
|
requests.actions.in_person_email | string |
In person email |
|
verification_code
|
requests.actions.verification_code | string |
Verification code |
|
attachment_size
|
requests.attachment_size | integer |
Size of the attachment |
|
message
|
message | string |
message |
|
status
|
status | string |
status |
Get data of completed request
Shows the details of a signed envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
request_name
|
document_form_data.request_name | string |
Request Name |
|
zsdocumentid
|
document_form_data.zsdocumentid | string |
Zoho Sign Documentid |
|
actions
|
document_form_data.actions | array of object |
actions |
|
signed_time
|
document_form_data.actions.signed_time | string |
Signed time |
|
action_type
|
document_form_data.actions.action_type | string |
Action type |
|
recipient_email
|
document_form_data.actions.recipient_email | string |
Recipient email |
|
recipient_name
|
document_form_data.actions.recipient_name | string |
Recipient name |
|
fields
|
document_form_data.actions.fields | array of object |
fields |
|
field_label
|
document_form_data.actions.fields.field_label | string |
Field label |
|
field_value
|
document_form_data.actions.fields.field_value | string |
Field value |
|
field_name
|
document_form_data.actions.fields.field_name | string |
Field name |
|
status
|
status | string |
status |
Get list of templates
Shows a list of all the document templates created
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
template_id
|
templates.template_id | string | |
|
template_name
|
templates.template_name | string |
Template name |
Get particular template details
Shows the details of a specific document template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List of Templates
|
template_id | True | string |
List of Templates |
Invoke API
Invoke API
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
URL Path
|
url | True | string |
Provide url path |
|
Method
|
method | True | string |
Select API Method to be used |
Returns
- response
- object
Recall a particular document
Recall a particular document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
Reminder for recipients
Send a reminder to recipients of a particular document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
request_id | True | integer |
Request ID |
SendSignRequest
Send the uploaded document out for signature
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
RequestId | True | string |
Request ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
status
|
status | string |
status |
Update the properties of a created request
Update the properties of a created request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request ID
|
RequestId | True | string |
Request ID |
|
Document Type
|
request_type_id | string |
request_type_id |
|
|
Document Name
|
request_name | True | string |
Name of the document (request) |
|
Recipient Name
|
recipient_name | string |
Recipient name |
|
|
Recipient Email
|
recipient_email | string |
Recipient email |
|
|
Phone Number
|
recipient_phonenumber | string |
Phone Number of recipient for SMS mode of authentication. |
|
|
Country Code
|
recipient_countrycode | string |
Country Code of recipient's phone number for SMS mode of authentication. |
|
|
ActionType
|
action_type | string |
Select whether the recipient is a Signer or a viewer or an approver or an inpersonSigner. |
|
|
Private Notes
|
private_notes | string |
Private notes |
|
|
Signing Order
|
signing_order | integer |
Signing order |
|
|
Need Authentication For Recipient
|
verify_recipient | boolean |
Whether the recipient needs to be verified by one of the authentication modes. |
|
|
Authentication Delivery Type
|
verification_type | string |
Verification type |
|
|
Verification Code
|
verification_code | string |
6 digit Verification Code for OFFLINE verification mode. |
|
|
Days to complete
|
expiration_days | integer |
Number of days left for the document to get expired. |
|
|
Send in order
|
is_sequential | boolean |
Allow recipients to sign in the specified order. |
|
|
Automatic reminders
|
email_reminders | boolean |
Enable periodic reminders for the recipients to sign the document. |
|
|
Send a remainder every - (days)
|
reminder_period | integer |
Specify the time interval at which a reminder for signing is to be sent to the recipients. |
|
|
Folder
|
folder_id | string |
folder unique id |
|
|
Notes
|
notes | html |
Notes for all recipients. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
code |
|
message
|
message | string |
message |
|
status
|
status | string |
status |
Triggers
| Zoho Sign Triggers |
Register a callback for a particular event |
Zoho Sign Triggers
Register a callback for a particular event
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Actions
|
webhook_actions | True | string |
Webhook actions |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
request_status
|
requests.request_status | string |
request status |
|
notes
|
requests.notes | string |
notes |
|
reminder_period
|
requests.reminder_period | integer |
reminder period |
|
owner_id
|
requests.owner_id | string |
owner id |
|
description
|
requests.description | string |
description |
|
request_name
|
requests.request_name | string |
Request name |
|
modified_time
|
requests.modified_time | integer |
Modified time |
|
action_time
|
requests.action_time | integer |
Action time |
|
is_deleted
|
requests.is_deleted | boolean |
Status of deleted |
|
expiration_days
|
requests.expiration_days | integer |
Expiration days |
|
is_sequential
|
requests.is_sequential | boolean |
Status of sequential operation |
|
sign_submitted_time
|
requests.sign_submitted_time | integer |
Sign submitted time |
|
owner_first_name
|
requests.owner_first_name | string |
Owner of the first name |
|
sign_percentage
|
requests.sign_percentage | integer |
Sign percentage |
|
expire_by
|
requests.expire_by | integer |
Expire by |
|
owner_email
|
requests.owner_email | string |
Owner email |
|
created_time
|
requests.created_time | integer |
Created time |
|
email_reminders
|
requests.email_reminders | boolean |
Email reminders |
|
document_ids
|
requests.document_ids | array of object |
Document ids list |
|
document_name
|
requests.document_ids.document_name | string |
Enter the document name |
|
document_size
|
requests.document_ids.document_size | integer |
Size of the document |
|
document_order
|
requests.document_ids.document_order | string |
Order of the document |
|
total_pages
|
requests.document_ids.total_pages | integer |
Total number of pages in the document |
|
document_id
|
requests.document_ids.document_id | string |
Document ID |
|
self_sign
|
requests.self_sign | boolean |
Status of self sign |
|
in_process
|
requests.in_process | boolean |
Status of in process |
|
validity
|
requests.validity | integer |
Validity |
|
request_type_name
|
requests.request_type_name | string |
Request type name |
|
decline_reason
|
requests.decline_reason | string |
Decline reason |
|
request_id
|
requests.request_id | string |
Request id |
|
request_type_id
|
requests.request_type_id | string |
Request type id |
|
owner_last_name
|
requests.owner_last_name | string |
Owner last name |
|
actions
|
requests.actions | array of object |
actions |
|
verify_recipient
|
requests.actions.verify_recipient | boolean |
Verify recipient |
|
action_type
|
requests.actions.action_type | string |
Type of action |
|
private_notes
|
requests.actions.private_notes | string |
Private notes |
|
recipient_email
|
requests.actions.recipient_email | string |
Recipient email |
|
allow_signing
|
requests.actions.allow_signing | boolean |
Status of signing |
|
recipient_phonenumber
|
requests.actions.recipient_phonenumber | string |
Recipient phonenumber |
|
is_bulk
|
requests.actions.is_bulk | boolean |
Status of bulk action |
|
action_id
|
requests.actions.action_id | string |
Action id |
|
is_revoked
|
requests.actions.is_revoked | boolean |
Status of revoke |
|
is_embedded
|
requests.actions.is_embedded | boolean |
Status of embedded |
|
signing_order
|
requests.actions.signing_order | integer |
Signing order |
|
recipient_name
|
requests.actions.recipient_name | string |
Recipient name |
|
action_status
|
requests.actions.action_status | string |
Action status |
|
recipient_countrycode
|
requests.actions.recipient_countrycode | string |
Country Code of the recipient |
|
performed_by_email
|
notifications.performed_by_email | string |
Performed by email |
|
performed_at
|
notifications.performed_at | integer |
Performed at |
|
reason
|
notifications.reason | string |
Reason |
|
activity
|
notifications.activity | string |
Activity |
|
operation_type
|
notifications.operation_type | string |
Operation Type |
|
action_id
|
notifications.action_id | string |
Action id |
|
performed_by_name
|
notifications.performed_by_name | string |
Performed by name |
|
signing_order
|
notifications.signing_order | integer |
Signing order |
|
ip_address
|
notifications.ip_address | string |
Ip address |
Definitions
file
This is the basic data type 'file'.
object
This is the type 'object'.