Send documents using templates

Send document out for signature using templates

In order to use the template, the recipient details need to be given. In the previous call the actions array contains a number of recipients.
It may or may not have an email address.
When using the template, the actions need to be sent along with email id and name for all.
The number of actions cannot be changed. In case there are document fields to be filled (document_fields array) then the value for those also needs to be filled.
If the “is_mandatory” is true for a field, then it must have a value,else value need not be sent.

ARGUMENTS

Param	Datatype	Description
request_name	String	Name in which the document needs to be created by default same as template name.
field_data	JSON Object	All values for the prefill data will be present.
actions	JSON Array
notes *	String	Message to be sent to all recipients in common
is_quicksend *	Boolean	Quick Send

Action

Param	Datatype	Description
recipient_name *	String	Recipient name
recipient_email *	String	Recipient email
in_person_name *	String	Inperson recipient name
in_person_email	String	Inperson recipient email
private_notes	String	Private notes for each recipient
verify_recipient *	Boolean	Authentication needs to be done or not
verification_type *	String	Verification Mode [EMAIL]

API Root Endpoint

POST https://sign.zoho.com/api/v1/templates/[Template Id]/createdocument

Request example

$ curl https://sign.zoho.com/api/v1/templates/[Template Id]/createdocument \
    -X POST \
    -H "Authorization: Zoho-oauthtoken <Oauth Token>"\
    -d 'data={
  "templates": {
    "field_data": {
      "field_text_data": {},
      "field_boolean_data": {},
      "field_date_data": {},
    },
    "actions": [
      {
        "action_id": "2000000468052",
        "action_type": "SIGN",
        "recipient_name": "S********",
        "role": "ts1",
        "recipient_email": "s********@***.com",
        "recipient_phonenumber": "",
        "recipient_countrycode": "",
        "private_notes": "",
        "verify_recipient": true,
        "verification_type": "EMAIL"
      }
    ],
    "notes": ""
  }
}&is_quicksend=true'

Show full

Show less

Response example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "requests": {
    "request_status": "inprogress",
    "notes": "Hi\nA note\nMr. Tester\nHow ar eyouuu ?",
    "owner_id": "2000000002002",
    "description": "",
    "request_name": "Leave a note test",
    "modified_time": 1522746018025,
    "action_time": 1522746018310,
    "is_deleted": false,
    "expiration_days": 1,
    "is_sequential": true,
    "sign_submitted_time": 1522746018310,
    "owner_first_name": "V*******",
    "sign_percentage": 33.34,
    "expire_by": 1522866540000,
    "is_expiring": true,
    "owner_email": "v**********@***.com",
    "created_time": 1522746018025,
    "document_ids": [
      {
        "image_string": "<BASE 64 Image String>",
        "document_name": "Employee NDA.pdf",
        "pages": [
          {
            "image_string": "<BASE 64 Image String>",
            "page": 0,
            "is_thumbnail": true
          }
        ],
        "document_size": 26591,
        "document_order": "0",
        "total_pages": 2,
        "document_id": "2000000492171"
      }
    ],
    "self_sign": false,
    "in_process": false,
    "request_type_name": "Others",
    "request_id": "2000000492177",
    "request_type_id": "2000000000135",
    "owner_last_name": "",
    "actions": [
      {
        "verify_recipient": false,
        "action_id": "2000000492180",
        "action_type": "SIGN",
        "private_notes": "",
        "recipient_email": "s***********@***.com",
        "signing_order": 0,
        "fields": [
          {
            "field_id": "2000000492182",
            "field_category": "image",
            "field_label": "Signature",
            "is_mandatory": true,
            "page_no": 0,
            "document_id": "2000000492171",
            "field_name": "Signature",
            "y_coord": 3,
            "action_id": "2000000492180",
            "abs_width": 22,
            "field_type_name": "Signature",
            "description_tooltip": "",
            "x_coord": 42,
            "abs_height": 5
          },
          {
            "field_id": "2000000492183",
            "field_category": "image",
            "field_label": "Initial",
            "is_mandatory": true,
            "page_no": 0,
            "document_id": "2000000492171",
            "field_name": "Initial",
            "y_coord": 3,
            "action_id": "2000000492180",
            "abs_width": 18,
            "field_type_name": "Initial",
            "description_tooltip": "",
            "x_coord": 71,
            "abs_height": 5
          }
        ],
        "recipient_name": "s***********",
        "allow_signing": true,
        "action_status": "UNOPENED",
        "recipient_phonenumber": "",
        "recipient_countrycode": ""
      }
    ]
  },
  "status": "success"
}

Show full

Show less

Request Demo

By Industry

Platform

By Departments

By Size

By Geography

CRM

Voice

Sign

Forms

Bigin

SalesIQ

Bookings

RouteIQ

Thrive

CRM Plus

Zakya

Campaigns

Voice

Sign

Forms

Social

Survey

SalesIQ

Sites

Backstage

PageSense

Marketing Automation

LandingPage

Webinar

LeadChain

Domains

CommunitySpaces

Thrive

Publish

Marketing Plus

Commerce

Zakya

Desk

Assist

Voice

SalesIQ

Bookings

FSM

Lens

Solo

Service Plus

Books

Expense

Sign

Inventory

Invoice

Billing

Payroll

Commerce

Checkout

Practice

Solo

Payments

Finance Plus

Mail

Voice

Sign

WorkDrive

Bookings

Cliq

Notebook

Meeting

Connect

Learn

Office Integrator

Writer

TeamInbox

ZeptoMail

Show

Tables

Sheet

Office Suite

Calendar

ToDo

PDF Editor