Create template
This will help you to create a new template
ARGUMENTS
Param | Datatype | Description |
|---|---|---|
| template_name * | String | Name of the template |
| 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 |
| actions | JSON array |
Actions
Param | Datatype | Description |
|---|---|---|
| role * | String | Role of the recipient |
| 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] |
| 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] |
API Root Endpoint
POST https://sign.zoho.com/api/v1/templatesRequest example
$ curl https://sign.zoho.com/api/v1/templates \
-H "Authorization: Zoho-oauthtoken <Oauth Token>"\
-F 'file=@Path to file' \
-F 'data={
"templates": {
"template_name": "Template 1",
"request_type_id": "2000000000135",
"expiration_days": 1,
"is_sequential": true,
"reminder_period": 8,
"email_reminders": false,
"actions": [
{
"action_type": "SIGN",
"signing_order": 0,
"recipient_name": "",
"role": "1",
"recipient_email": "",
"recipient_phonenumber": "",
"recipient_countrycode": "",
"private_notes": "Please get back to us for further queries",
"verify_recipient": true,
"verification_type": "EMAIL",
"verification_code": ""
}
]
}
}'Show full
Show less
Response example
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
"code": 0,
"templates": {
"owner_email": "v****@***.com",
"created_time": 1522746328987,
"email_reminders": false,
"document_ids": [
{
"image_string": "<BASE 64 Image String>",
"pages": [
{
"image_string": "<BASE 64 Image String>",
"page": 0,
"is_thumbnail": true
}
],
"document_size": 174307,
"document_order": "0",
"total_pages": 4,
"document_id": "2000000493029"
}
],
"notes": "",
"reminder_period": 8,
"owner_id": "2000000002002",
"document_fields": [
{
"document_id": "2000000493029",
"fields": []
}
],
"description": "",
"template_name": "Template 1",
"modified_time": 1522746328987,
"is_deleted": false,
"expiration_days": 1,
"is_sequential": true,
"template_id": "2000000493035",
"request_type_name": "Others",
"owner_first_name": "V*******",
"request_type_id": "2000000000135",
"owner_last_name": "",
"actions": [
{
"verify_recipient": true,
"role": "1",
"action_id": "2000000493038",
"action_type": "SIGN",
"private_notes": "Please get back to us for further queries",
"recipient_email": "",
"signing_order": 0,
"verification_type": "EMAIL",
"fields": [],
"recipient_name": "",
"recipient_phonenumber": "",
"recipient_countrycode": ""
}
]
},
"message": "Template has been added ",
"status": "success"
}Show full
Show less