Skip to main content
Zoho Sign logo
  • Category: signatures
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 43
  • Triggers: 0
  • Slug: ZOHO_SIGN
  • Version: 20261101_00

Tools

Slug: ZOHO_SIGN_CREATE_FOLDERCreate a persistent Zoho Sign folder. Zoho Sign provides no folder-delete API endpoint, so this action cannot automatically clean up the folder.

Input Parameters

string
required
Name for the new folder. The folder persists after creation because Zoho Sign provides no folder-delete API endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_REQUESTUpload 1-40 PDF documents and create a Zoho Sign draft request. This action does not send the request to recipients.

Input Parameters

array
required
PDF documents to add to the draft. Provide 1-40 files, each no larger than 25 MB, with a combined size no larger than 40 MB.
array
Optional recipient actions; omit to create a recipient-free draft.
object
required
Draft request settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_REQUEST_FROM_MERGED_TEMPLATESCreate one Zoho Sign request from two or more compatible templates. quick_send=true immediately submits the request and irreversibly emails external recipients, requiring a paid API-capable plan and submission credits. This endpoint’s page does not guarantee that quick_send=false creates a draft, so use false only when that uncertainty is acceptable.

Input Parameters

string
Common notes attached to the merged request; omit for no notes.
array
required
Recipient mappings based on Merge View output; include each action that must be assigned in the merged request.
object
Prefill values for fields in the merged templates. Omit when no merged template fields need prefilled values.
boolean
required
Required explicit send choice. true immediately submits the request and irreversibly emails external recipients, requiring a paid API-capable Zoho Sign plan and submission credits. The Merge Send page does not guarantee draft-only behavior when false.
array
required
Two or more compatible template IDs previously checked with Merge View, in the order they should be merged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_REQUEST_FROM_TEMPLATECreate a Zoho Sign request from a template. quick_send must be chosen explicitly: true irreversibly emails external recipients and requires a paid API-capable plan and send credits; false creates an editable draft.

Input Parameters

string
required
Common message sent to all recipients.
array
required
Template role assignments and recipients; include every action defined by the template.
boolean
required
Explicitly choose whether to send immediately. true irreversibly emails recipients and requires a paid API-capable Zoho Sign plan and send credits; false creates an editable draft without sending.
string
required
Template ID used to create the request.
string
Name for the generated request; Zoho uses the template name if omitted.
object
Template prefill date values keyed by field label or name.
object
Template prefill text values keyed by field label or name.
object
Template prefill checkbox values keyed by field label or name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_REQUEST_TYPECreate a persistent Zoho Sign document/request type. Zoho Sign provides no request-type delete API endpoint, so this action cannot automatically clean up the request type.

Input Parameters

string
required
Name for the new request type. The request type persists after creation because Zoho Sign provides no request-type delete API endpoint.
string
Optional description for the new request type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_SIGNER_GROUPCreate a persistent Zoho Sign signer group with named email recipients. Zoho Sign provides no signer-group delete API endpoint, so this action cannot automatically clean up the group.

Input Parameters

string
required
Name for the signer group. The group persists after creation because Zoho Sign provides no signer-group delete API endpoint.
array
required
People who can satisfy signing actions assigned to this group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_CREATE_TEMPLATEUpload 1-40 PDF documents and create a reusable Zoho Sign template with recipient roles and signer fields.

Input Parameters

array
required
PDF template documents to upload. Provide 1-40 files, each no larger than 25 MB, with a combined size no larger than 40 MB.
string
Template notes.
array
required
Reusable recipient roles and their assigned fields.
string
Folder ID returned by List Folders.
boolean
required
Whether assigned recipients must act in signing order.
string
required
Reusable template name.
boolean
Whether automatic reminders are enabled by default.
integer
Default request expiration in days.
integer
Default number of days between reminders.
string
Request type ID returned by List Request Types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DELETE_DOCUMENTPermanently delete one document file from an owned Zoho Sign request. This destructive action cannot be undone and does not delete the whole request.

Input Parameters

string
required
Document file ID to permanently remove from its Zoho Sign request. This cannot be undone and does not delete the whole request; only use an owned document when permanent deletion is intended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DELETE_REQUESTDestructively move an owned Zoho Sign request to trash. This is a soft delete rather than immediate permanent erasure. Optionally recall an in-progress request first, which stops its remaining signing process.

Input Parameters

string
Reason Zoho Sign should record for recalling or deleting the request.
string
required
Owned request ID to move to trash. This removes the request from active workflows; only delete a request when that destructive action is intended.
boolean
Whether to recall an in-progress request before moving it to trash. Recalling stops the remaining signing process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DELETE_TEMPLATEDestructively move an owned reusable Zoho Sign template to trash. This is a soft delete rather than immediate permanent erasure.

Input Parameters

string
required
Owned template ID to move to trash. This removes the reusable template from active use; only delete it when that destructive action is intended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DOWNLOAD_COMPLETION_CERTIFICATEDownload the PDF completion certificate for a fully signed request. Draft and in-progress requests do not have a certificate; completing a request through the API requires a paid API-capable Zoho Sign plan and credits.

Input Parameters

string
required
Completed request ID whose PDF completion certificate to download. The request must already be fully signed; completing requests through the API requires a paid API-capable Zoho Sign plan and credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DOWNLOAD_DOCUMENTDownload one PDF document from a Zoho Sign request.

Input Parameters

string
required
Request containing the document.
string
required
Document ID returned in the request’s document_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_DOWNLOAD_REQUESTDownload all documents in a Zoho Sign request as a PDF or ZIP, optionally merged and including the completion certificate.

Input Parameters

boolean
Merge multiple documents into one PDF instead of returning a ZIP archive.
string
required
Request ID whose documents to download.
string
Password used to protect the downloaded PDF or ZIP archive when applicable.
boolean
Include the completion certificate when it is available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_EMAIL_COMPLETED_REQUESTImmediately email an owned completed Zoho Sign request to one to three addresses. The request must have completed signing, which generally depends on the paid API submission workflow. This sends real external email; confirm every destination before calling, and check delivery before retrying to avoid duplicate messages.

Input Parameters

string
required
Completed request ID whose documents should be emailed. The request must already have completed signing.
array
required
One to three destination email addresses. Calling this action immediately sends real external email containing the completed request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_EXTEND_REQUESTExtend the signing-link expiration date of an owned sent request. The request must already have been submitted through Zoho Sign’s paid, credit-consuming API-send workflow.

Input Parameters

string
required
New expiration date in DD Month YYYY format using an English month name, for example ‘30 November 2026’.
string
required
Owned sent request ID whose signing-link expiration should be extended. The request must have been submitted through the paid API-send workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GENERATE_EMBEDDED_SIGNING_URLGenerate a one-time URL for a human to sign one recipient action from a previously submitted request. The recipient must have been configured as an embedded SIGN action before submission; API submission requires a paid Zoho Sign plan and send credits. This action does not sign the document. Hand the URL to the intended signer immediately because it must be opened within two minutes and can be used only once.

Input Parameters

string
Origin hosting the iframe, for example https://example.com. Required when the signing page will be rendered in an iframe; omit when opening it in a new tab or window.
string
required
Recipient action ID configured with action_type SIGN and is_embedded=true before the request was submitted.
string
required
Previously submitted request ID containing an embedded SIGN recipient. Submitting through the API requires a paid Zoho Sign plan and send credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GENERATE_REQUEST_EMBEDDED_SEND_URLGenerate a short-lived, human-facing embedded editor URL for an owned active draft request. Open the URL within two minutes to start a one-hour session. This action only creates the handoff URL; it does not send the request.

Input Parameters

string
required
Owned active draft request ID to open in Zoho Sign’s embedded editor. The draft must already contain a recipient or role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GENERATE_TEMPLATE_EMBEDDED_SEND_URLGenerate a short-lived embedded editor and sending URL for an owned Zoho Sign template. Open the URL within two minutes to start a one-hour human editing session. Generating the URL does not itself send a request; a completed send may require paid API entitlement and credits.

Input Parameters

string
required
Owned template ID to open in the embedded editor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GET_ORGANIZATIONGet the connected Zoho Sign organization, license label, administrative context, and relevant template, embedded-workflow, and signer-group feature flags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GET_REQUESTGet one request’s status, documents, recipient actions, and signer fields.

Input Parameters

string
required
Request ID returned by Create Request or List Requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GET_REQUEST_FIELD_DATAGet recipient-entered field labels and values from a completed Zoho Sign request. Draft and in-progress requests do not have completed field data.

Input Parameters

string
required
Completed request ID whose recipient-entered field values to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GET_REQUEST_REMINDER_SETTINGSGet automatic email reminder settings for an owned Zoho Sign request.

Input Parameters

string
required
Request ID whose automatic reminder settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_GET_TEMPLATEGet one Zoho Sign template’s documents, reusable recipient roles, signer fields, and prefill fields.

Input Parameters

string
required
Template ID returned by Create Template or List Templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_FIELD_TYPESList account-specific Zoho Sign field type IDs, names, categories, and mandatory defaults for use when placing signer fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_FOLDERSReturn one controllable page of Zoho Sign folders.

Input Parameters

object
Page, sort, search, and continuation controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_MY_REQUESTSReturn one controllable page of requests assigned to or pending for the connected Zoho Sign user.

Input Parameters

object
Page, sort, search, and continuation controls.
string
Zoho request status or category filter, such as my_pending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_REQUESTSReturn one controllable page of Zoho Sign document requests, optionally filtered by status and search columns.

Input Parameters

object
Page, sort, search, and continuation controls.
string
Zoho request status to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_REQUEST_TYPESReturn one controllable page of Zoho Sign document request types.

Input Parameters

object
Page, sort, search, and continuation controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_SIGNER_GROUP_RECIPIENTSReturn one page of recipients for a Zoho Sign signer group. An empty result does not prove that the signer group exists.

Input Parameters

object
Page, sort, search, and continuation controls.
string
required
Signer group ID whose recipients to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_SIGNER_GROUPSReturn one controllable page of Zoho Sign signer groups, optionally filtered by group name.

Input Parameters

object
Page, sort, search, and continuation controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_TEMPLATESReturn one controllable page of reusable Zoho Sign templates.

Input Parameters

object
Page, sort, search, and continuation controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_LIST_USERSReturn one controllable page of users in the connected Zoho Sign organization without email addresses or profile photos.

Input Parameters

object
Page, sort, search, and continuation controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_MARK_REQUEST_FOR_CORRECTIONMove an owned in-progress request into correction mode before any signer completes. The request must have been submitted through a paid, credit-consuming API-send workflow.

Input Parameters

string
required
In-progress request ID to move into correction mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_MERGE_TEMPLATES_INTO_REQUESTMerge at least two owned templates into an existing owned Zoho Sign draft request. This updates the draft but does not submit it or send it to recipients.

Input Parameters

string
Organization ID context. Zoho documents this field but not its datatype or requiredness.
string
required
Existing owned draft request ID to update.
string
Replacement request name to apply while merging.
array
required
IDs of at least two owned templates to merge into the draft request.
array
Action values to delete while merging. Zoho documents this as an array but does not publish its item schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_PREVIEW_TEMPLATE_MERGEPreview whether two or more Zoho Sign templates are compatible for merging and retrieve the merged fields and recipient roles. This read-only preview does not create a request or send anything.

Input Parameters

array
required
Two or more Zoho Sign template IDs to check for merge compatibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_RECALL_REQUESTIrreversibly recall an owned sent Zoho Sign request and cancel its remaining signing process. Recipients can no longer view or sign the request after recall. The request must already have been submitted through the paid, credit-consuming API-send workflow.

Input Parameters

string
required
Owned sent request ID to recall. Recalling permanently cancels the remaining signing process and prevents recipients from viewing or signing the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_REMIND_REQUEST_RECIPIENTSImmediately send a real reminder email to every pending recipient of an owned sent request. This externally visible action requires the paid API-send workflow, and repeated calls send additional email reminders.

Input Parameters

string
required
Owned sent request whose pending recipients should receive a reminder. A successful call immediately sends real external email; repeated calls send additional reminders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_SELF_SIGN_REQUESTIrreversibly apply the connected user’s legal signature and complete an owned Zoho Sign self-sign request. The request must already be configured for self-signing and in a signable state. This requires an API-capable paid plan; confirm the request and field values before calling because signing cannot be undone.

Input Parameters

array
required
Existing self-sign actions with completed field values. A successful call applies an irreversible legal signature and completes the request.
object
Current request values to include when Zoho’s self-sign contract requires them.
string
required
Owned self-sign request ID to complete. The request must already be in a state that permits self-signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_SUBMIT_REQUESTIrreversibly send an owned Zoho Sign draft request to its recipients after applying final signer fields. This requires an API-capable paid plan and send credits; Zoho documents a cost of five credits per envelope submission.

Input Parameters

array
required
Final recipient actions and signer fields. Submitting sends real emails, consumes Zoho Sign credits, and cannot be undone.
string
required
Owned draft request ID to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_UPDATE_REQUESTUpdate an owned draft or correction-mode request, including settings, recipients, fields, and optional added files. This does not send the request.

Input Parameters

array
Optional documents to append or replace, up to 40 files, 25 MB each and 40 MB total.
array
required
Recipient actions and fields to add or update, up to 25 recipients.
object
required
Complete request settings; request_name and is_sequential are required.
string
required
Draft or correction-mode request ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_UPDATE_REQUEST_TYPEUpdate an existing Zoho Sign document request type’s name and optionally its description. A replacement name is required even when changing the description.

Input Parameters

string
required
Replacement request type name.
string
Replacement request type description.
string
required
Request type ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_UPDATE_SIGNER_GROUPRename an owned Zoho Sign signer group, add recipients, and remove existing recipients by ID.

Input Parameters

string
required
Replacement signer group name.
array
New recipients to add to the signer group.
string
required
Signer group ID to update.
array
Existing recipient IDs to remove from the signer group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SIGN_UPDATE_TEMPLATEUpdate an owned Zoho Sign template’s settings, reusable roles, signer fields, field removals, and optional added PDF documents.

Input Parameters

array
Optional PDF documents to add, up to 40 files, each no larger than 25 MB and with a combined upload size no larger than 40 MB.
string
Replacement template notes.
array
Role actions, fields, and deleted field IDs to update.
string
Replacement folder ID.
string
required
Owned template ID to update.
boolean
Replacement sequential-signing setting.
string
Replacement template name.
array
Document-level fields to add or update and existing field IDs to remove.
boolean
Replacement automatic reminder setting.
integer
Replacement default expiration in days.
integer
Replacement reminder interval in days.
string
Replacement request type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not