Zoho Sign

Electronic signatures. Send files and templates for signature, track, remind, extend and recall them, and download signed documents and completion certificates.

Actions

Action	What it does
Create document	Upload a file as a draft document with one recipient (and optionally people who get a copy).
Create document type	Create a document type (category) to give documents.
Create folder	Create a folder to file documents in.
Delete document	Move a document to the Zoho Sign trash.
Download completion certificate	Download the certificate Zoho Sign issues once every recipient has completed a document.
Download document	Download the document as a PDF (a ZIP when it holds several files), optionally with its completion certificate.
Download one file	Download one file of a document as a PDF.
Extend document expiry	Give the recipients of a sent document until a later date.
Get document	Get a document's status, files and recipients, with each recipient's progress.
Get filled-in fields	Get what each recipient entered in the document's fields, and every value by field label.
Get template	Get a template's recipients (roles) and prefill fields, whose labels are the keys for 'Send template'.
List document types	List the document types (categories) documents can have.
List documents	List the account's documents (signature requests), newest first, optionally only those with one status or matching a search.
List folders	List the account's folders.
List templates	List the account's templates, newest first.
Recall document	Withdraw a sent document so its recipients can no longer sign it.
Remind recipients	Email a reminder to the recipients who have not acted yet.
Send document for signature	Send a draft to its recipients, placing a signature field for each signer.
Send template	Create a document from a template and send it, or keep it as a draft.
Update draft document	Change a draft's name, message, expiry, reminders, folder, type or signing order.

Create document

Upload a file as a draft document with one recipient (and optionally people who get a copy). Send it with 'Send document for signature'.

Inputs

FilefiletextRequired: The file to sign: upload one, use a file from an earlier step, or paste an https link. PDF, Word, OpenDocument, Excel, RTF, text, HTML, JPG or PNG, up to 25 MB.
Document namerequest_nametextRequired: The name recipients see.
Recipient namerecipient_nametextRequired: The recipient's full name.
Recipient emailrecipient_emailtextRequired: The recipient's email address.
Recipientaction_typetext: Optional. What the recipient does (signs by default).One of: SIGN (Signs), VIEW (Receives a copy), APPROVER (Approves).
Also send a copy tocopy_tolist: Optional. Email addresses that receive the signed document, after the recipient.
Messagenotestext: Optional. A message sent to every recipient.
Folderfolder_idtext: Optional. The folder to file the document in.
Document typerequest_type_idtext: Optional. The document type (category) to give the document.
Days to signexpiration_daysnumber: Optional. How many days the recipients have to act.From 1 to 365.
Remind every (days)reminder_periodnumber: Optional. Email the recipients a reminder this often.From 1 to 365.
Sign in ordersequentialtrue/false: Optional. Recipients act one after another (on by default); turn off to send to everyone at once.Default: true.
Verify recipient by emailverify_recipienttrue/false: Optional. The recipient must enter a code Zoho emails them before signing.Default: false.
Test modetestingtrue/false: Optional. Send as a test document, which uses no Zoho Sign credits. Zoho allows 50 a month on the Enterprise and API plans.Default: false.

Outputs

A Zoho Sign document (a signature request).

action_timenumber: When it was last acted on, in epoch milliseconds.
actionslist: The recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The document's description.
document_idslist: The files in the document.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days it stays open for signing.
expire_bynumber: When it expires, in epoch milliseconds.
folder_idtext: The folder's id.
folder_nametext: The folder's name.
is_deletedtrue/false: Whether it is in the trash.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The message sent to every recipient.
owner_emailtext: The sender's email address.
owner_first_nametext: The sender's first name.
owner_idtext: The sender's Zoho id.
owner_last_nametext: The sender's last name.
reminder_periodnumber: Days between reminders.
request_idtext: The document's id.
request_nametext: The document's name.
request_statustext: draft, inprogress, completed, declined, recalled, expired and so on.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
sign_percentagenumber: How much of the signing is done.
sign_submitted_timenumber: When it was sent, in epoch milliseconds.

Example output

{
  "actions": [
    {
      "action_id": "2000000492185",
      "action_status": "NOACTION",
      "action_type": "SIGN",
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signing_order": 1,
      "verify_recipient": false
    }
  ],
  "created_time": 1790000000000,
  "document_ids": [
    {
      "document_id": "2000000492183",
      "document_name": "contract.pdf",
      "document_order": "0",
      "document_size": 13264,
      "total_pages": 1
    }
  ],
  "email_reminders": false,
  "expiration_days": 15,
  "is_sequential": true,
  "modified_time": 1790000000000,
  "notes": "",
  "owner_email": "ada@example.com",
  "owner_first_name": "Ada",
  "owner_last_name": "Lovelace",
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "request_status": "draft",
  "request_type_name": "Others",
  "sign_percentage": 0
}

Create document type

Create a document type (category) to give documents.

Inputs

NamenametextRequired: The document type's name.
Descriptiondescriptiontext: Optional. What the type is for.

Outputs

A Zoho Sign document type.

request_type_descriptiontext: The document type's description.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.

Example output

{
  "request_type_description": "",
  "request_type_id": "2000000490101",
  "request_type_name": "Contracts"
}

Create folder

Create a folder to file documents in.

Inputs

Folder namefolder_nametextRequired: The new folder's name.

Outputs

A Zoho Sign folder.

folder_idtext: The folder's id.
folder_nametext: The folder's name.

Example output

{
  "folder_id": "2000000490001",
  "folder_name": "Contracts"
}

Delete document

Move a document to the Zoho Sign trash.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
Recall it if it is out for signaturerecall_if_in_progresstrue/false: Optional. Needed to delete a document that is still out for signature.Default: false.
Reasonreasontext: Optional. Why it is being recalled.

Outputs

Zoho Sign's confirmation.

action_timenumber: When it happened, in epoch milliseconds.
messagetext: Zoho Sign's message.
request_idtext: The document's id.

Example output

{
  "message": "Document deleted successfully",
  "request_id": "2000000492177"
}

Download completion certificate

Download the certificate Zoho Sign issues once every recipient has completed a document.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.

Outputs

The downloaded file, kept in Lodol's file storage.

byte_sizenumber: The file's size in bytes.
content_typetext: application/pdf, or application/zip for several files.
document_reftext: The stored file's reference, for a later step's file input.
documentslist: The stored files.
filenametext: The file's name.
request_idtext: The document's id.
urltext: Where the stored file can be opened.

Example output

{
  "byte_size": 13264,
  "content_type": "application/pdf",
  "document_ref": "doc_00000000000000000000000000000000",
  "documents": [
    {
      "content_type": "application/pdf",
      "document_ref": "doc_00000000000000000000000000000000",
      "filename": "contract.pdf",
      "size_bytes": 13264,
      "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
    }
  ],
  "filename": "contract.pdf",
  "request_id": "2000000492177",
  "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
}

Download document

Download the document as a PDF (a ZIP when it holds several files), optionally with its completion certificate.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
Include completion certificatewith_certificatetrue/false: Optional. Add the completion certificate.Default: false.
Merge into one PDFmergetrue/false: Optional. Merge all signed files and the certificate into one PDF.Default: false.
Passwordpasswordtext: Optional. The document's password, if it has one.

Outputs

The downloaded file, kept in Lodol's file storage.

byte_sizenumber: The file's size in bytes.
content_typetext: application/pdf, or application/zip for several files.
document_reftext: The stored file's reference, for a later step's file input.
documentslist: The stored files.
filenametext: The file's name.
request_idtext: The document's id.
urltext: Where the stored file can be opened.

Example output

{
  "byte_size": 13264,
  "content_type": "application/pdf",
  "document_ref": "doc_00000000000000000000000000000000",
  "documents": [
    {
      "content_type": "application/pdf",
      "document_ref": "doc_00000000000000000000000000000000",
      "filename": "contract.pdf",
      "size_bytes": 13264,
      "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
    }
  ],
  "filename": "contract.pdf",
  "request_id": "2000000492177",
  "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
}

Download one file

Download one file of a document as a PDF.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
File IDdocument_idtextRequired: The file's id (document_ids[].document_id), from 'Get document' or 'Create document'.

Outputs

The downloaded file, kept in Lodol's file storage.

byte_sizenumber: The file's size in bytes.
content_typetext: application/pdf, or application/zip for several files.
document_reftext: The stored file's reference, for a later step's file input.
documentslist: The stored files.
filenametext: The file's name.
request_idtext: The document's id.
urltext: Where the stored file can be opened.

Example output

{
  "byte_size": 13264,
  "content_type": "application/pdf",
  "document_ref": "doc_00000000000000000000000000000000",
  "documents": [
    {
      "content_type": "application/pdf",
      "document_ref": "doc_00000000000000000000000000000000",
      "filename": "contract.pdf",
      "size_bytes": 13264,
      "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
    }
  ],
  "filename": "contract.pdf",
  "request_id": "2000000492177",
  "url": "/actions/core/serve-document/doc_00000000000000000000000000000000"
}

Extend document expiry

Give the recipients of a sent document until a later date.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
New expiry dateexpire_bydateRequired: The new last day to sign; after today.

Outputs

Zoho Sign's confirmation.

expire_bytext: The new expiry date (YYYY-MM-DD).
messagetext: Zoho Sign's message.
request_idtext: The document's id.

Example output

{
  "expire_by": "2026-12-31",
  "message": "Document validity has been extended",
  "request_id": "2000000492177"
}

Get document

Get a document's status, files and recipients, with each recipient's progress.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.

Outputs

A Zoho Sign document (a signature request).

action_timenumber: When it was last acted on, in epoch milliseconds.
actionslist: The recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The document's description.
document_idslist: The files in the document.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days it stays open for signing.
expire_bynumber: When it expires, in epoch milliseconds.
folder_idtext: The folder's id.
folder_nametext: The folder's name.
is_deletedtrue/false: Whether it is in the trash.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The message sent to every recipient.
owner_emailtext: The sender's email address.
owner_first_nametext: The sender's first name.
owner_idtext: The sender's Zoho id.
owner_last_nametext: The sender's last name.
reminder_periodnumber: Days between reminders.
request_idtext: The document's id.
request_nametext: The document's name.
request_statustext: draft, inprogress, completed, declined, recalled, expired and so on.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
sign_percentagenumber: How much of the signing is done.
sign_submitted_timenumber: When it was sent, in epoch milliseconds.

Example output

{
  "actions": [
    {
      "action_id": "2000000492185",
      "action_status": "NOACTION",
      "action_type": "SIGN",
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signing_order": 1,
      "verify_recipient": false
    }
  ],
  "created_time": 1790000000000,
  "document_ids": [
    {
      "document_id": "2000000492183",
      "document_name": "contract.pdf",
      "document_order": "0",
      "document_size": 13264,
      "total_pages": 1
    }
  ],
  "email_reminders": false,
  "expiration_days": 15,
  "is_sequential": true,
  "modified_time": 1790000000000,
  "notes": "",
  "owner_email": "ada@example.com",
  "owner_first_name": "Ada",
  "owner_last_name": "Lovelace",
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "request_status": "draft",
  "request_type_name": "Others",
  "sign_percentage": 0
}

Get filled-in fields

Get what each recipient entered in the document's fields, and every value by field label.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.

Outputs

What the recipients filled in.

actionslist: The recipients.
request_idtext: The document's id.
request_nametext: The document's name.
valuesobject: Each field's value, by field label (Zoho sends text).
zsdocumentidtext: Zoho Sign's document number.

Example output

{
  "actions": [
    {
      "action_type": "SIGN",
      "fields": [
        {
          "field_label": "Company",
          "field_value": "Lodol"
        }
      ],
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signed_time": "Oct 01 2026 10:00 UTC"
    }
  ],
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "values": {
    "Company": "Lodol"
  },
  "zsdocumentid": "ZS-1"
}

Get template

Get a template's recipients (roles) and prefill fields, whose labels are the keys for 'Send template'.

Inputs

Template IDtemplate_idtextRequired: The template's id, from 'List templates'.

Outputs

A Zoho Sign template.

actionslist: The template recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The template's description.
document_fieldslist: The prefill fields per file.
document_idslist: The files in the template.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days a document from it stays open.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The template's message to recipients.
owner_emailtext: The owner's email address.
reminder_periodnumber: Days between reminders.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
template_idtext: The template's id.
template_nametext: The template's name.

Example output

{
  "actions": [
    {
      "action_id": "2000000493005",
      "action_type": "SIGN",
      "recipient_email": "",
      "recipient_name": "",
      "role": "Signer",
      "signing_order": 1
    }
  ],
  "document_fields": [],
  "document_ids": [
    {
      "document_id": "2000000493003",
      "document_name": "nda.pdf",
      "total_pages": 2
    }
  ],
  "expiration_days": 15,
  "is_sequential": true,
  "owner_email": "ada@example.com",
  "template_id": "2000000493001",
  "template_name": "NDA"
}

List document types

List the document types (categories) documents can have.

Inputs

None.

Outputs

The account's document types.

countnumber: How many document types there are.
document_typeslist: The document types.

Example output

{
  "count": 1,
  "document_types": [
    {
      "request_type_description": "",
      "request_type_id": "2000000490101",
      "request_type_name": "Others"
    }
  ]
}

List documents

List the account's documents (signature requests), newest first, optionally only those with one status or matching a search.

Inputs

Statusstatustext: Optional. Only documents with this status.One of: draft, inprogress (In progress), completed, declined, recalled, expired, expiring, onhold (On hold), archived, deleted, shredded.
Search insearch_columntext: Optional. Where to look for the search text.One of: request_name (Document name), folder_name (Folder name), owner_full_name (Sender name), recipient_email (Recipient email), recipient_name (Recipient name), form_name (Form name), template_name (Template name).
Search forsearch_valuetext: Optional. Text to look for; searches document names unless 'Search in' says otherwise.
Sort bysort_columntext: Optional. Created date unless changed.One of: created_time (Created), request_name (Name), folder_name (Folder), owner_full_name (Sender), recipient_email (Recipient email), form_name (Form).
Ordersort_ordertext: Optional. Newest first unless changed.One of: DESC (Newest first), ASC (Oldest first).
Start atstart_indexnumber: Optional. The position of the first result to return, from 1.At least 1.
Page sizerow_countnumber: Optional. How many to return, 1 to 100 (default 25).From 1 to 100.

Outputs

A page of documents.

countnumber: How many documents this page holds.
documentslist: The documents.
has_moretrue/false: Whether more documents follow.
start_indexnumber: The position of this page's first document, from 1.
total_countnumber: How many documents match in total.

Example output

{
  "count": 1,
  "documents": [
    {
      "actions": [
        {
          "action_id": "2000000492185",
          "action_status": "NOACTION",
          "action_type": "SIGN",
          "recipient_email": "grace@example.com",
          "recipient_name": "Grace Hopper",
          "signing_order": 1,
          "verify_recipient": false
        }
      ],
      "created_time": 1790000000000,
      "document_ids": [
        {
          "document_id": "2000000492183",
          "document_name": "contract.pdf",
          "document_order": "0",
          "document_size": 13264,
          "total_pages": 1
        }
      ],
      "email_reminders": false,
      "expiration_days": 15,
      "is_sequential": true,
      "modified_time": 1790000000000,
      "notes": "",
      "owner_email": "ada@example.com",
      "owner_first_name": "Ada",
      "owner_last_name": "Lovelace",
      "request_id": "2000000492177",
      "request_name": "Lodol QA contract",
      "request_status": "draft",
      "request_type_name": "Others",
      "sign_percentage": 0
    }
  ],
  "has_more": false,
  "start_index": 1,
  "total_count": 1
}

List folders

List the account's folders.

Inputs

None.

Outputs

The account's folders.

countnumber: How many folders there are.
folderslist: The folders.

Example output

{
  "count": 1,
  "folders": [
    {
      "folder_id": "2000000490001",
      "folder_name": "Contracts"
    }
  ]
}

List templates

List the account's templates, newest first.

Inputs

Ordersort_ordertext: Optional. Newest first unless changed.One of: DESC (Newest first), ASC (Oldest first).
Start atstart_indexnumber: Optional. The position of the first result to return, from 1.At least 1.
Page sizerow_counttext: Optional. How many to return (default 25).One of: 10, 25, 50, 100.

Outputs

A page of templates.

countnumber: How many templates this page holds.
has_moretrue/false: Whether more templates follow.
start_indexnumber: The position of this page's first template, from 1.
templateslist: The templates.
total_countnumber: How many templates there are in total.

Example output

{
  "count": 1,
  "has_more": false,
  "start_index": 1,
  "templates": [
    {
      "actions": [
        {
          "action_id": "2000000493005",
          "action_type": "SIGN",
          "recipient_email": "",
          "recipient_name": "",
          "role": "Signer",
          "signing_order": 1
        }
      ],
      "document_fields": [],
      "document_ids": [
        {
          "document_id": "2000000493003",
          "document_name": "nda.pdf",
          "total_pages": 2
        }
      ],
      "expiration_days": 15,
      "is_sequential": true,
      "owner_email": "ada@example.com",
      "template_id": "2000000493001",
      "template_name": "NDA"
    }
  ],
  "total_count": 1
}

Recall document

Withdraw a sent document so its recipients can no longer sign it.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.

Outputs

Zoho Sign's confirmation.

action_timenumber: When it happened, in epoch milliseconds.
messagetext: Zoho Sign's message.
request_idtext: The document's id.

Example output

{
  "action_time": 1790000000000,
  "message": "Document has been recalled",
  "request_id": "2000000492177"
}

Remind recipients

Email a reminder to the recipients who have not acted yet.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.

Outputs

Zoho Sign's confirmation.

action_timenumber: When it happened, in epoch milliseconds.
messagetext: Zoho Sign's message.
request_idtext: The document's id.

Example output

{
  "message": "Reminder has been sent",
  "request_id": "2000000492177"
}

Send a draft to its recipients, placing a signature field for each signer. Positions are in points from the page's top-left (an A4 page is 595 wide and 842 tall); further signers' fields go below the first. Uses 5 Zoho Sign credits unless in test mode.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
Place a signature fieldplace_signaturetrue/false: Optional. On by default. Turn off when the file already has Zoho Sign text tags marking where to sign.Default: true.
Pagepagenumber: Optional. The page to sign on, from 1 (default 1).At least 1.
From the leftxnumber: Optional. The field's left edge in points (default 50).At least 0.
From the topynumber: Optional. The field's top edge in points (default 760, near the foot of an A4 page).At least 0.
Widthwidthnumber: Optional. In points (default 135).At least 10.
Heightheightnumber: Optional. In points (default 19).At least 5.
File IDdocument_idtext: Optional. Which file to sign on when the document has several (document_ids[].document_id); the first by default.
Test modetestingtrue/false: Optional. Send as a test document, which uses no Zoho Sign credits. Zoho allows 50 a month on the Enterprise and API plans.Default: false.

Outputs

A Zoho Sign document (a signature request).

action_timenumber: When it was last acted on, in epoch milliseconds.
actionslist: The recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The document's description.
document_idslist: The files in the document.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days it stays open for signing.
expire_bynumber: When it expires, in epoch milliseconds.
folder_idtext: The folder's id.
folder_nametext: The folder's name.
is_deletedtrue/false: Whether it is in the trash.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The message sent to every recipient.
owner_emailtext: The sender's email address.
owner_first_nametext: The sender's first name.
owner_idtext: The sender's Zoho id.
owner_last_nametext: The sender's last name.
reminder_periodnumber: Days between reminders.
request_idtext: The document's id.
request_nametext: The document's name.
request_statustext: draft, inprogress, completed, declined, recalled, expired and so on.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
sign_percentagenumber: How much of the signing is done.
sign_submitted_timenumber: When it was sent, in epoch milliseconds.

Example output

{
  "actions": [
    {
      "action_id": "2000000492185",
      "action_status": "NOACTION",
      "action_type": "SIGN",
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signing_order": 1,
      "verify_recipient": false
    }
  ],
  "created_time": 1790000000000,
  "document_ids": [
    {
      "document_id": "2000000492183",
      "document_name": "contract.pdf",
      "document_order": "0",
      "document_size": 13264,
      "total_pages": 1
    }
  ],
  "email_reminders": false,
  "expiration_days": 15,
  "is_sequential": true,
  "modified_time": 1790000000000,
  "notes": "",
  "owner_email": "ada@example.com",
  "owner_first_name": "Ada",
  "owner_last_name": "Lovelace",
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "request_status": "inprogress",
  "request_type_name": "Others",
  "sign_percentage": 0
}

Send template

Create a document from a template and send it, or keep it as a draft. Recipients are filled in signing order; any left blank keep the recipient saved in the template. Sending uses 5 Zoho Sign credits unless in test mode.

Inputs

Template IDtemplate_idtextRequired: The template's id, from 'List templates'.
Recipient emailsrecipient_emailslist: Optional. One email per template recipient, in signing order.
Recipient namesrecipient_nameslist: Optional. Their names, in the same order (the part before the @ otherwise).
Document namerequest_nametext: Optional. The template's name unless given.
Field valuesfield_valuesobject: Optional. Prefill fields by label (see 'Get template'). Checkboxes take true or false; dates use the template's date format.
Messagenotestext: Optional. A message sent to every recipient.
Send nowquick_sendtrue/false: Optional. On by default; turn off to keep the document as a draft for 'Send document for signature'.Default: true.
Test modetestingtrue/false: Optional. Send as a test document, which uses no Zoho Sign credits. Zoho allows 50 a month on the Enterprise and API plans.Default: false.

Outputs

A Zoho Sign document (a signature request).

action_timenumber: When it was last acted on, in epoch milliseconds.
actionslist: The recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The document's description.
document_idslist: The files in the document.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days it stays open for signing.
expire_bynumber: When it expires, in epoch milliseconds.
folder_idtext: The folder's id.
folder_nametext: The folder's name.
is_deletedtrue/false: Whether it is in the trash.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The message sent to every recipient.
owner_emailtext: The sender's email address.
owner_first_nametext: The sender's first name.
owner_idtext: The sender's Zoho id.
owner_last_nametext: The sender's last name.
reminder_periodnumber: Days between reminders.
request_idtext: The document's id.
request_nametext: The document's name.
request_statustext: draft, inprogress, completed, declined, recalled, expired and so on.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
sign_percentagenumber: How much of the signing is done.
sign_submitted_timenumber: When it was sent, in epoch milliseconds.

Example output

{
  "actions": [
    {
      "action_id": "2000000492185",
      "action_status": "NOACTION",
      "action_type": "SIGN",
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signing_order": 1,
      "verify_recipient": false
    }
  ],
  "created_time": 1790000000000,
  "document_ids": [
    {
      "document_id": "2000000492183",
      "document_name": "contract.pdf",
      "document_order": "0",
      "document_size": 13264,
      "total_pages": 1
    }
  ],
  "email_reminders": false,
  "expiration_days": 15,
  "is_sequential": true,
  "modified_time": 1790000000000,
  "notes": "",
  "owner_email": "ada@example.com",
  "owner_first_name": "Ada",
  "owner_last_name": "Lovelace",
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "request_status": "inprogress",
  "request_type_name": "Others",
  "sign_percentage": 0
}

Update draft document

Change a draft's name, message, expiry, reminders, folder, type or signing order. Blank fields keep their current value.

Inputs

Document IDrequest_idtextRequired: The document's id (request_id), from 'List documents' or 'Create document'. An address copied from Zoho Sign works too.
Document namerequest_nametext: Optional. A new name.
Messagenotestext: Optional. A message sent to every recipient.
Days to signexpiration_daysnumber: Optional. How many days the recipients have to act.From 1 to 365.
Email remindersemail_reminderstext: Optional. Turn reminders on or off.One of: on, off.
Remind every (days)reminder_periodnumber: Optional. Email the recipients a reminder this often.From 1 to 365.
Folderfolder_idtext: Optional. The folder to file the document in.
Document typerequest_type_idtext: Optional. The document type (category) to give the document.
Signing ordersigning_ordertext: Optional. In order, or everyone at once.One of: sequential (In order), parallel (All at once).

Outputs

A Zoho Sign document (a signature request).

action_timenumber: When it was last acted on, in epoch milliseconds.
actionslist: The recipients.
created_timenumber: When it was created, in epoch milliseconds.
descriptiontext: The document's description.
document_idslist: The files in the document.
email_reminderstrue/false: Whether Zoho sends reminders.
expiration_daysnumber: Days it stays open for signing.
expire_bynumber: When it expires, in epoch milliseconds.
folder_idtext: The folder's id.
folder_nametext: The folder's name.
is_deletedtrue/false: Whether it is in the trash.
is_sequentialtrue/false: Whether recipients act in order.
modified_timenumber: When it last changed, in epoch milliseconds.
notestext: The message sent to every recipient.
owner_emailtext: The sender's email address.
owner_first_nametext: The sender's first name.
owner_idtext: The sender's Zoho id.
owner_last_nametext: The sender's last name.
reminder_periodnumber: Days between reminders.
request_idtext: The document's id.
request_nametext: The document's name.
request_statustext: draft, inprogress, completed, declined, recalled, expired and so on.
request_type_idtext: The document type's id.
request_type_nametext: The document type's name.
sign_percentagenumber: How much of the signing is done.
sign_submitted_timenumber: When it was sent, in epoch milliseconds.

Example output

{
  "actions": [
    {
      "action_id": "2000000492185",
      "action_status": "NOACTION",
      "action_type": "SIGN",
      "recipient_email": "grace@example.com",
      "recipient_name": "Grace Hopper",
      "signing_order": 1,
      "verify_recipient": false
    }
  ],
  "created_time": 1790000000000,
  "document_ids": [
    {
      "document_id": "2000000492183",
      "document_name": "contract.pdf",
      "document_order": "0",
      "document_size": 13264,
      "total_pages": 1
    }
  ],
  "email_reminders": false,
  "expiration_days": 15,
  "is_sequential": true,
  "modified_time": 1790000000000,
  "notes": "",
  "owner_email": "ada@example.com",
  "owner_first_name": "Ada",
  "owner_last_name": "Lovelace",
  "request_id": "2000000492177",
  "request_name": "Lodol QA contract",
  "request_status": "draft",
  "request_type_name": "Others",
  "sign_percentage": 0
}

ActionsCopy Anchor Link

Create documentCopy Anchor Link

Inputs

Outputs

Create document typeCopy Anchor Link

Inputs

Outputs

Create folderCopy Anchor Link

Inputs

Outputs

Delete documentCopy Anchor Link

Inputs

Outputs

Download completion certificateCopy Anchor Link

Inputs

Outputs

Download documentCopy Anchor Link

Inputs

Outputs

Download one fileCopy Anchor Link

Inputs

Outputs

Extend document expiryCopy Anchor Link

Inputs

Outputs

Get documentCopy Anchor Link

Inputs

Outputs

Get filled-in fieldsCopy Anchor Link

Inputs

Outputs

Get templateCopy Anchor Link

Inputs

Outputs

List document typesCopy Anchor Link

Inputs

Outputs

List documentsCopy Anchor Link

Inputs

Outputs

List foldersCopy Anchor Link

Inputs

Outputs

List templatesCopy Anchor Link

Inputs

Outputs

Recall documentCopy Anchor Link

Inputs

Outputs

Remind recipientsCopy Anchor Link

Inputs

Outputs

Send document for signatureCopy Anchor Link

Inputs

Outputs

Send templateCopy Anchor Link

Inputs

Outputs

Update draft documentCopy Anchor Link

Inputs

Outputs

On this page

Actions

Create document

Create document type

Create folder

Delete document

Download completion certificate

Download document

Download one file

Extend document expiry

Get document

Get filled-in fields

Get template

List document types

List documents

List folders

List templates

Recall document

Remind recipients

Send document for signature

Send template

Update draft document