Zoho Sign API

https://www.zoho.com/sign/api
Admin
Zoho Sign API is a REST-based digital signature solution that enables developers to integrate secure...
Tokens:120,858
Snippets:670
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Get Template List Response Example

Source: https://www.zoho.com/sign/api/template-managment/get-template-list.html

Example HTTP response from the Zoho Sign API when retrieving a list of templates. Shows the JSON structure with template details, document information, and pagination context.

```http
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": [
        {
          "document_name": "4page170kbsquared file testrotated.pdf",
          "document_size": 174307,
          "document_order": "0",
          "total_pages": 4,
          "document_id": "2000000493029"
        }
      ],
      "notes": "",
      "reminder_period": 8,
      "owner_id": "2000000002002",
      "description": "",
      "template_name": "Template 1",
      "modified_time": 1522747039504,
      "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",
          "recipient_name": "",
          "recipient_phonenumber": "",
          "recipient_countrycode": ""
        }
      ]
    }
  ],
  "message": "Template list retrieved successfully",
  "page_context": {
    "sort_column": "created_time",
    "has_more_rows": true,
    "start_index": 1,
    "total_count": 12,
    "sort_order": "DESC",
    "row_count": 10
  },
  "status": "success"
}
```

--------------------------------

### Response example for folder list

Source: https://www.zoho.com/sign/api/document-managment/get-folder-list.html

Example JSON response showing a successful folder retrieval with folder names and IDs.

```json
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "folders": [
    {
      "folder_name": "Quote Folder",
      "folder_id": "2000000495005"
    },
    {
      "folder_name": "NDA",
      "folder_id": "2000000489161"
    }
  ],
  "message": "Folder(s) retrieved successfully",
  "status": "success"
}
```

--------------------------------

### Get template details - curl request example

Source: https://www.zoho.com/sign/api/template-managment/get-template-details.html

Example curl request to fetch template details. Uses the Authorization header with a Zoho OAuth token. Replace :Template_ID with the actual template ID.

```bash
curl --location 'https://sign.zoho.com/api/v1/templates/:Template_ID \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
```

--------------------------------

### Download PDF - Response Example

Source: https://www.zoho.com/sign/api/document-managment/download-particular-pdf.html

Example response showing a successful download with HTTP 200 and PDF content type.

```http
HTTP/1.1 200 OK
Content-Type:application/pdf;
```

--------------------------------

### Request example

Source: https://www.zoho.com/sign/api/document-managment/recall-document.html

Example curl command to recall a document. Replace :Request_Id with the actual request ID and provide a valid OAuth token.

```bash
curl --location --request POST 'https://sign.zoho.com/api/v1/requests/:Request_Id/recall' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### Response example

Source: https://www.zoho.com/sign/api/document-managment/recall-document.html

Example response from the recall endpoint. A successful recall returns HTTP 200 with a message indicating the document has been recalled.

```http
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "action_time": 1546600722216,
    "message": "Document has been recalled",
    "status": "success"
}
```

--------------------------------

### Request example: curl GET request with Authorization header

Source: https://www.zoho.com/sign/api/document-managment/get-document-type.html

Use this curl command to make a GET request to the endpoint. It requires an Authorization header with a Zoho OAuth token.

```bash
curl https://sign.zoho.com/api/v1/requesttypes \
    --header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### Send document using template with Node.js fetch

Source: https://www.zoho.com/sign/api/use-cases/sending-a-document-using-template.html

Node.js Express example that first fetches template details via GET /api/v1/templates/<Template-Id> and then sends a document using the template via POST /api/v1/templates/{template_id}/createdocument. It uses fetch and FormData, sets the Authorization header with a Zoho OAuth token, and handles errors with a failure response.

```javascript
const express = require('express');
const FormData = require('form-data');
const fetch = require('node-fetch');

const app = express();
const port = 4000;

app.get('/sendTemplate', async (req, res) => {
    let HEADERS = {};
    HEADERS['Authorization'] = 'Zoho-oauthtoken <Oauth Token>';
    let URL = 'https://sign.zoho.com/api/v1/templates/<Template-Id>';
    let method = 'GET';
    let requestOptions = {
        method: method,
        headers: HEADERS
    };

    let response = await fetch(URL, requestOptions)
        .then((_res) => {
            console.log(`Return code is ${_res.status}`);
            return _res.json().then((responseJson) => {
                return responseJson['templates'];
            });
        })
        .catch((error) => {
            let errorResponse = {};
            errorResponse['message'] = 'call failed to initiate'; //check internet connection or proper DC type
            errorResponse['status'] = 'failure';
            res.send(errorResponse);
        });
    let template_id = response.template_id;
    let actionsJson = {};
    actionsJson['action_id'] = response.actions[0].action_id;
    actionsJson['recipient_name'] = response.actions[0].recipient_name;
    actionsJson['recipient_email'] = response.actions[0].recipient_email;
    actionsJson['action_type'] = response.actions[0].action_type;

    let templates = {};
    templates['actions'] = new Array(actionsJson);

    let data = {};
    data['templates'] = templates;
    var payload = new FormData();
    payload.append('data', JSON.stringify(data));
    payload.append('is_quicksend', 'true');
    let requestOptions1 = {
        method: 'POST',
        headers: HEADERS,
        body: payload
    };
    let URL1 = 'https://sign.zoho.com/api/v1/templates/' + template_id + '/createdocument';
    let response1 = await fetch(URL1, requestOptions1)
        .then((_res) => {
            console.log(`Return code is ${_res.status}`);
            return _res.json().then((responseJson) => {
                res.send(responseJson);
                return responseJson['templates'];
            });
        })
        .catch((error) => {
            let errorResponse = {};
            errorResponse['message'] = 'call failed to initiate'; //check internet connection or proper DC type
            errorResponse['status'] = 'failure';
            res.send(errorResponse);
        });
});

app.listen(port, () => {
    console.log(`Example app listening on port  {port}`);
});
```

--------------------------------

### Get Request Details Response Example (JSON)

Source: https://www.zoho.com/sign/api/document-managment/update-document.html

Example JSON response from the Zoho Sign API when retrieving request details. It includes signer actions with fields like checkboxes, text fields, and signature fields, along with their properties and validation rules.

```json
{
    "requests": {
        "request_name": "NDA",
        "actions": [
            {
                "action_id": "14197000000767351",
                "recipient_name": "Alex James",
                "recipient_email": "abc@example.com",
                "action_type": "SIGN",
                "fields": {
                    "check_boxes": [
                        {
                            "field_name": "Checkbox-1",
                            "field_label": "Checkbox",
                            "field_type_name": "Checkbox",
                            "document_id": "14197000000767335",
                            "action_id": "14197000000767351",
                            "is_mandatory": true,
                            "x_coord": 50,
                            "y_coord": 50,
                            "abs_width": 50,
                            "abs_height": 50,
                            "page_no": 0,
                            "default_value": true,
                            "is_read_only": false,
                            "description_tooltip": "You agree to this"
                        }
                    ],
                    "text_fields": [
                        {
                            "field_name": "Textfield-1",
                            "field_label": "Textfield",
                            "field_type_name": "Textfield",
                            "document_id": "14197000000767335",
                            "action_id": "14197000000767351",
                            "is_mandatory": true,
                            "x_coord": 50,
                            "y_coord": 50,
                            "abs_width": 50,
                            "abs_height": 50,
                            "page_no": 0,
                            "default_value": "Text field - 1 default value",
                            "description_tooltip": "description of text field",
                            "text_property": {
                                "font_size": 15,
                                "font_color": "000000",
                                "font": "Liberation Serif",
                                "is_italic": true,
                                "is_underline": true,
                                "is_bold": true,
                                "is_read_only": true,
                                "is_fixed_width": false,
                                "is_fixed_height": true,
                                "max_field_length": 200
                            },
                            "name_format": "FULL_NAME",
                            "validation": {
                                "validation_type": "CUSTOM",
                                "validation_regex": ".*",
                                "validation_error_message": "Only Numbers are allowed in this field"
                            }
                        }
                    ]
                }
            },
            {
                "action_id": "14197000000767356",
                "action_type": "INPERSONSIGN",
                "recipient_email": "xyz@example.com",
                "recipient_name": "Alex James",
                "in_person_name": "David",
                "in_person_email": "david@example.com",
                "fields": {
                    "image_fields": [
                        {
                            "field_name": "Signature",
                            "field_label": "Signature",
                            "field_type_name": "Signature",
                            "document_id": "14197000000767335",
                            "action_id": "14197000000767356",
                            "is_mandatory": true,
                            "x_coord": 50,
                            "y_coord": 50,
                            "abs_width": 50,
                            "abs_height": 50,
                            "page_no": 0,
                            "is_resizable": true,
                            "is_draggable": true,
                            "description_tooltip": "Add your signature"
                        }
                    ]
                }
            }
        ]
    }
}
```

--------------------------------

### cURL Request Example

Source: https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html

Use this curl command to make a GET request to the Zoho Sign API. Replace ':Request_Id' with the actual request ID and provide a valid OAuth token in the Authorization header.

```bash
curl --location 'https://sign.zoho.com/api/v1/requests/:Request_Id' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### cURL Request Example

Source: https://www.zoho.com/sign/api/document-managment/remind-recipient.html

Example of sending a reminder using cURL. Replace :Request_Id with the actual request ID and provide a valid OAuth token in the Authorization header.

```bash
curl --location --request POST 'https://sign.zoho.com/api/v1/requests/:Request_Id/remind' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### Zoho Sign API - Get Document Details Response Example

Source: https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html

Example response from the Zoho Sign API when retrieving details of a particular document. Shows a successful request with status 'success' and message 'Document has been retrieved'. The response includes request metadata, owner information, and an actions array with signing details.

```http
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "code": 0,
    "requests": {
        "request_status": "completed",
        "notes": "",
        "attachments": [],
        "reminder_period": 5,
        "owner_id": "212541000000010003",
        "description": "",
        "request_name": "NDA policy",
        "modified_time": 1712729617557,
        "action_time": 1712729733535,
        "is_deleted": false,
        "expiration_days": 15,
        "is_sequential": true,
        "sign_submitted_time": 1712729617725,
        "templates_used": [],
        "owner_first_name": "John Zylker",
        "sign_percentage": 100,
        "expire_by": 1714069740000,
        "owner_email": "john.zylker@securesign.com",
        "created_time": 1710743911169,
        "email_reminders": true,
        "document_fields": [
            {
                "document_id": "212541000000244007",
                "fields": []
            }
        ],
        "request_type_name": "Others",
        
        "zsdocumentid": "2C130346-HSSVKF3S3CZ_HZZWYZ7LWSWI1BSQUKRIPI59W8XNLMI",
        "request_type_id": "212541000000000135",
        "owner_last_name": "Zylker",
        "actions": [
            {
                "verify_recipient": false,
                "recipient_countrycode_iso": "",
                "action_type": "SIGN",
                "private_notes": "",
                "cloud_provider_name": "Zoho Sign",
                "recipient_email": "barbara.zylker@securesign.com",
                "language": "en",
                "recipient_phonenumber": "",
                "is_bulk": false,
                "action_id": "212541000000244028",
                "cloud_provider_id": 10,
                "signing_order": 1,
                "fields": [
                    {
                        "field_id": "212541000000247031",
                        "x_coord": 454,
                        "field_type_id": "212541000000000141",
                        "abs_height": 19,
                        "field_category": "image",
                        "field_label": "Signature",
                        "is_mandatory": true,
                        "page_no": 0,
                        "document_id": "212541000000244007",
                        "is_draggable": false,
                        "field_name": "Signature",
                        "y_value": 8.354922,
                        "abs_width": 135,
                        "action_id": "212541000000244028",
                        "width": 22.045263,
                        "y_coord": 66,
                        "field_type_name": "Signature",
                        "description_tooltip": "",
                        "x_value": 74.11568,
                        "is_resizable": true,
                        "height": 2.46114
                    }
                ],
                "recipient_name": "Barbara",
                "delivery_mode": "EMAIL",
                "action_status": "SIGNED",
                "recipient_countrycode": ""           
            }
        ],
        "attachment_size": 0
    },
    "message": "Document has been retrieved",
    "status": "success"
}
```

--------------------------------

### cURL Request Example

Source: https://www.zoho.com/sign/api/document-managment/get-document-form-data.html

Example cURL command to call the fielddata endpoint. Replace the placeholder token and request ID as needed.

```bash
curl --location 'https://sign.zoho.com/api/v1/requests/:Request_Id/fielddata' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
```

--------------------------------

### Request example: Create signer group

Source: https://www.zoho.com/sign/api/signergroups/create.html

Example request body for creating a signer group. Includes signing_group_name and recipients array with recipient_name and recipient_email.

```json
data= {
  "signing_group_name": "SecureSign24x7 - Finance",
  "recipients": [
    {
      "recipient_name": "John Zylker",
      "recipient_email": "john.zylker@securesign24x7.com"
    },
    {
      "recipient_name": "Barbara Zylker",
      "recipient_email": "barbara.zylker@securesign24x7.com"
    }
  ]
}
```

--------------------------------

### Response example for signer group details

Source: https://www.zoho.com/sign/api/signergroups/details.html

Example response showing a list of recipients in the signer group. Each recipient object includes fields like recipient_email, recipient_name, recipient_id, and signing_group_id.

```json
{
 "code": 0,
 "recipients": [
 {
 "recipient_countrycode_iso": "IN",
 "recipient_email": "test1@zohosign.com",
 "signing_group_id": "5000000005001",
 "recipient_name": "Test1",
 "recipient_id": "5000000005003",
 "recipient_phonenumber": ""
 },
 {
 "recipient_countrycode_iso": "IN",
 "recipient_email": "test2@zohosign.com",
 "signing_group_id": "5000000005001",
 "recipient_name": "Test2",
 "recipient_id": "5000000005005",
 "recipient_phonenumber": ""
 },
 {
 "recipient_countrycode_iso": "IN",
 "recipient_email": "test3@zohosign.com",
 "signing_group_id": "5000000005001",
 "recipient_name": "Test3",
 "recipient_id": "5000000005007",
 "recipient_phonenumber": ""
 },
 {
 "recipient_countrycode_iso": "IN",
 "recipient_email": "test4@zohosign.com",
 "signing_group_id": "5000000005001",
 "recipient_name": "Test4",
 "recipient_id": "5000000005009",
 "recipient_phonenumber": ""
 },
 {
 "recipient_countrycode_iso": "IN",
 "recipient_email": "test5@zohosign.com",
 "signing_group_id": "5000000005001",
 "recipient_name": "Test5",
 "recipient_id": "5000000005011",
 "recipient_phonenumber": ""
 }
 ],
 "message": "List of signer group recipients retrieved",
 "page_context": {
 "has_more_rows": false,
 "start_index": 1,
 "total_count": 5,
 "sort_order": "ASC",
 "row_count": 5
 },
 "status": "success"
}
```

--------------------------------

### cURL Request Example for Completion Certificate

Source: https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html

Example curl command to retrieve the completion certificate. Replace :Request_Id with the actual request ID and provide a valid Zoho OAuth token.

```bash
curl --location 'https://sign.zoho.com/api/v1/requests/:Request_Id/completioncertificate' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
```

--------------------------------

### PHP: Create document and add recipients, then add fields and submit for signature

Source: https://www.zoho.com/sign/api/use-cases/sending-a-document-for-signature.html

This PHP example creates a document request with a recipient, then adds a text field and submits the request for signature. It uses the Zoho Sign API endpoints for creating and submitting requests. The code includes error handling and saves the request ID for later updates.

```php
<?php
//Create document and add recipients

$actionsJson = new stdClass();
$actionsJson->recipient_name = "<Recipient-Name>";
$actionsJson->recipient_email = "<Recipient-Email>";
$actionsJson->action_type = "SIGN";
$actionsJson->private_notes = "Please get back to us for further queries";
$actionsJson->signing_order = 0;
$actionsJson->verify_recipient = true;
$actionsJson->verification_type = "EMAIL";

$requestJSON = new stdClass();
$requestJSON->request_name = "<Request-Name>";
$requestJSON->expiration_days = 1;
$requestJSON->is_sequential = true;
$requestJSON->email_reminders = true;
$requestJSON->reminder_period = 8;
$requestJSON->actions = array($actionsJson);

$request = new stdClass();
$request->requests = $requestJSON;
$data = json_encode($request);
$POST_DATA = array(
    'data' => $data,
    'file' => new CURLfile("<File-Path>")
);
$curl = curl_init("https://sign.zoho.com/api/v1/requests");
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Authorization:Zoho-oauthtoken <Oauth-Token>',
    "Content-Type:multipart/form-data"
));
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $POST_DATA);
$response = curl_exec($curl);
$jsonbody = json_decode($response); // contain filed tyes response
if ($jsonbody->status == "success") {
    $createdRequestId = $jsonbody->requests->request_id; //Save the ID from the response to update later
    $createdRequest = new stdClass();
    $createdRequest = $jsonbody->requests;
} else //Error check for error
{
    echo $jsonbody->message;
}
curl_close($curl);


//Add fields and send out document

$actionsJson = new stdClass();
$actionsJson->action_id = $createdRequest->actions[0]->action_id;
$actionsJson->recipient_name = $createdRequest->actions[0]->recipient_name;
$actionsJson->recipient_email = $createdRequest->actions[0]->recipient_email;
$actionsJson->action_type = $createdRequest->actions[0]->action_type;

$fieldJson = new stdClass();
$fieldJson->document_id = $createdRequest->document_ids[0]->document_id;
$fieldJson->field_name = "TextField";
$fieldJson->field_type_name = "Textfield";
$fieldJson->field_label = "Text - 1";
$fieldJson->field_category = "Textfield";
$fieldJson->abs_width = "200";
$fieldJson->abs_height = "18";
$fieldJson->is_mandatory = true;
$fieldJson->x_coord = "30";
$fieldJson->y_coord = "30";
$fieldJson->page_no = 0;

$actionsJson->fields = array($fieldJson);
$requestJSON = new stdClass();
$requestJSON->actions = array($actionsJson);
$request = new stdClass();
$request->requests = $requestJSON;
$data = json_encode($request);
$POST_DATA = array(
    'data' => $data
);
$curl = curl_init("https://sign.zoho.com/api/v1/requests/" . $createdRequestId . "/submit");
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Authorization:Zoho-oauthtoken <Oauth-Token>',
));
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $POST_DATA);
$response = curl_exec($curl);
echo $response;
$jsonbody = json_decode($response); // contain filed tyes response
if ($jsonbody->status == "success") {
    $created_request_id = $jsonbody->requests->request_id; //Save the ID from the response to update later
    $status = $jsonbody->requests->request_status;
    echo $status;
} else //Error check for error
{
    echo $jsonbody->message;
}
curl_close($curl);
?>
```

--------------------------------

### Send document for signature with Zoho Sign API (C#)

Source: https://www.zoho.com/sign/api/use-cases/sending-a-document-for-signature.html

Constructs a JSON payload with date and image fields, then submits the document for signature using the Zoho Sign API. The example adds fields to a recipient action and sends the request to the /submit endpoint.

```csharp
fieldJson = new JObject();
fieldJson.Add("field_name", "Sign Date");
fieldJson.Add("field_label", "Sign Date");
fieldJson.Add("field_type_name", "Date");
fieldJson.Add("page_no", 0);
fieldJson.Add("abs_width", "200");
fieldJson.Add("abs_height", "18");
fieldJson.Add("x_coord", 20 + i * 100);
fieldJson.Add("y_coord", 20 + i * 100);
fieldJson.Add("document_id", document_id);
date_fields.Add(fieldJson);
fields.Add("image_fields", image_fields);
fields.Add("date_fields", date_fields);
action.Add("fields", fields);
recipientActions.Add(action);
}
}
}
requestObj = new JObject(); 
requestObj.Add("actions", recipientActions);

JObject dataJson = new JObject();
dataJson.Add("requests", requestObj);

string dataStr = Newtonsoft.Json.JsonConvert.SerializeObject(dataJson);

// Send Document for Signature
Client = new RestClient("https://sign.zoho.com/api/v1/requests/" +  requestId + "/submit");
var submitRequest = new RestRequest();
submitRequest.AddHeader("Authorization", "Zoho-oauthtoken " + accessToken);
submitRequest.AddParameter("data", dataStr);
var response = Client.Post(submitRequest);
var content = response.Content;
string responseString = content.ToString();
```

--------------------------------

### Send document using template with PHP cURL

Source: https://www.zoho.com/sign/api/use-cases/sending-a-document-using-template.html

PHP cURL example that sends a document using a template by POSTing to the Zoho Sign API endpoint /api/v1/templates/{templateId}/createdocument. It sets the Authorization header with a Zoho OAuth token, sends multipart/form-data with the template data and is_quicksend flag, and checks the response status for success or error.

```php
$templatesData=json_encode($templateJSON);
$POST_DATA = array(
    'data' => $templatesData,
    "is_quicksend"=>"true"
);
$curl = curl_init("https://sign.zoho.com/api/v1/templates/".$templateId."/createdocument");
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Authorization:Zoho-oauthtoken <Oauth-Token>',
    "Content-Type:multipart/form-data"
));
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $POST_DATA);
$response = curl_exec($curl);
$jsonbody = json_decode($response); // contain filed tyes response
if ($jsonbody->status == "success") {
    $templateId = $jsonbody->templates->template_id;
    //Save the ID from the response to update later
    $createdTemplate=new stdClass();
    $createdTemplate = $jsonbody->templates;
} 
else //Error check for error
{
    echo $jsonbody->message;
}
curl_close($curl);
?>
```

--------------------------------

### Response example for creating a folder

Source: https://www.zoho.com/sign/api/document-managment/create-new-folder.html

Sample JSON response indicating success. Contains code 0, a success message, and request type details.

```json
{
    "code": 0,
    "message": "Document type added successfully",
    "request_types": [
        {
            "request_type_description": "Testing document types",
            "request_type_name": "New Doc Type",
            "request_type_id": "5376************1"
        }
    ],
    "status": "success"
}
```

--------------------------------

### Sample response: template object with actions

Source: https://www.zoho.com/sign/api/how-tos/merge-and-send-templates.html

Sample response showing the template object with owner details, actions array containing signature fields, and template metadata. Includes template_id, expiration_days, and is_sequential.

```json
"owner_id": "24036000000026003",
"description": "",
"template_name": "Test forms",
"is_deleted": false,
"modified_time": 1702458726158,
"expiration_days": 15,
"is_sequential": true,
"template_id": "24036000000362043,24036000000370015",
"owner_first_name": "John",
"request_type_name": "Others",
"validity": -1,
"actions": [
    {
        "ishost": false,
        "verify_recipient": false,
        "role": "",
        "recipient_countrycode_iso": "",
        "action_type": "SIGN",
        "private_notes": "",
        "recipient_email": "john***@***.com",
        "language": "en",
        "recipient_phonenumber": "",
        "action_id": "24036000000363002",
        "signing_order": 1,
        "fields": [
            {
                "field_id": "24036000000363007",
                "x_coord": 307,
                "field_type_id": "24036000000000047",
                "abs_height": 65,
                "field_category": "image",
                "field_label": "Signature",
                "is_mandatory": true,
                "page_no": 0,
                "document_id": "24036000000362044",
                "is_draggable": false,
                "field_name": "Signature",
                "y_value": 9.165126,
                "abs_width": 187,
                "action_id": "24036000000363002",
                "width": 30.595974,
                "y_coord": 73,
                "field_type_name": "Signature",
                "description_tooltip": "",
                "is_resizable": true,
                "x_value": 50.22922,
                "height": 8.240912
            },
            {
                "field_id": "24036000000370019",
                "x_coord": 435,
                "field_type_id": "24036000000000047",
                "abs_height": 20,
                "field_category": "image",
                "field_label": "Signature",
                "is_mandatory": true,
                "page_no": 0,
                "document_id": "24036000000370001",
                "is_draggable": false,
                "field_name": "Signature",
                "y_value": 23.952557,
                "abs_width": 135,
                "action_id": "24036000000370018",
                "width": 22.025114,
                "y_coord": 190,
                "field_type_name": "Signature",
                "description_tooltip": "",
                "is_resizable": true,
                "x_value": 71.158066,
                "height": 2.464572
            }
        ],
        "recipient_name": "John",
        "delivery_mode": "EMAIL",
        "recipient_countrycode": ""
    }
],
"owner_last_name": "Smith",
"request_type_id": "24036000000000187"
}
```

--------------------------------

### cURL request to get folder list

Source: https://www.zoho.com/sign/api/document-managment/get-folder-list.html

Example cURL command to call the folders endpoint with an OAuth token.

```bash
$ curl https://sign.zoho.com/api/v1/folders \
    --header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### Get Document Form Data - Response Example

Source: https://www.zoho.com/sign/api/document-managment/get-document-form-data.html

Example response from the Get Document Form Data API. Shows a successful request (HTTP 200) with the document form data, including the document ID, request name, and an array of actions with recipient details and field values. Field values may be masked (e.g., '******') or use placeholders like '_' and '-'. The response includes a 'code' of 0 and 'status' of 'success'.

```http
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "document_form_data": {
        "request_name": "Student Details.pdf",
        "zsdocumentid": "CWME3N7DBV6-QIGQ_LENFZVZEWSSO1SBXZBGTUR96EI",
        "actions": [
            {
                "signed_time": "May 21 2019 14:01 IST",
                "action_type": "SIGN",
                "recipient_email": "va******@******.com",
                "recipient_name": "Va******",
                "fields": [
                    {
                        "field_label": "Checkbox - 2",
                        "field_value": "false"
                    },
                    {
                        "field_label": "Checkbox - 1",
                        "field_value": "false"
                    },
                    {
                        "field_label": "Last name",
                        "field_value": "******"
                    },
                    {
                        "field_label": "Middle Name",
                        "field_value": "_"
                    },
                    {
                        "field_label": "Email",
                        "field_value": "va******@******.com"
                    },
                    {
                        "field_label": "Phone no.",
                        "field_value": "-"
                    },
                    {
                        "field_label": "Comment",
                        "field_value": "******"
                    },
                    {
                        "field_label": "Date - 1",
                        "field_value": "May 01 2019"
                    },
                    {
                        "field_label": "Dropdown - 1",
                        "field_value": "******"
                    }
                ]
            }
        ]
    },
    "status": "success"
}

```

--------------------------------

### Send document using template (Python)

Source: https://www.zoho.com/sign/api/use-cases/sending-a-document-using-template.html

Fetches template details and sends a document using the template. It populates recipient actions and prefill fields (text, date, dropdown, checkbox) and calls the createdocument endpoint with is_quicksend set to True.

```python
def getTemplateDetailsUsingTemplateID(template_id,Oauthtoken):
	headers = {'Authorization':'Zoho-oauthtoken '+Oauthtoken}
	r = requests.get(domainName + '/api/v1/templates/'+template_id,headers=headers)
	return r.json()

def sendDocumentUsingTemplate(template_id,respjson,Oauthtoken):
	headers = {'Authorization':'Zoho-oauthtoken '+Oauthtoken}
	temp_data={}
	prefillfieldsJsonArray = respjson['document_fields']
	actionsJsonArray = respjson['actions']
	#Adding recipient to the template
	newActionArray = []
	for i in actionsJsonArray:
		newAction={}
		newAction['recipient_email']="<recipient_email>"
		newAction['recipient_name']="<recipient_name>"
		newAction['action_id']=i['action_id']
		newAction['action_type']=i['action_type']
		newAction['private_notes']=""
		newAction['signing_order']=i['signing_order']
		newActionArray.append(newAction)
	temp_data['actions']=newActionArray
	#Addding data to PreFill Fields
	text_data={}
	date_data={}
	boolean_data={}
	for i in prefillfieldsJsonArray:
		if 'fields' in i:
			fieldsArr = i['fields']
			for j in fieldsArr:
				if j['field_category'] == 'datefield':
					date_data[j['field_label']] = "04 November 2019" # Adding date field data in this format dd MMMM yyyy
				if j['field_category'] == 'textfield':
					text_data[j['field_label']] = "Some Value"
				if j['field_category'] == 'dropdown':
					text_data[j['field_label']] = j['dropdown_values'][0]['dropdown_value']
				if j['field_category'] == 'checkbox':
					boolean_data[j['field_label']] = True # Value should be True/False 
	prefill_data = {}
	prefill_data['field_text_data'] = text_data
	prefill_data['field_date_data'] = date_data
	prefill_data['field_boolean_data'] = boolean_data
	temp_data['field_data'] = prefill_data
	data={}
	data['templates']=temp_data
	data_json={}
	data_json['data'] = json.dumps(data)
	data_json['is_quicksend'] = True
	url = domainName + '/api/v1/templates/'+template_id+'/createdocument'
	r = requests.post(url, data=data_json, headers=headers)
	return r.json()
respjson = getTemplateDetailsUsingTemplateID('<Template ID>',Oauthtoken)
respjson=respjson['templates']
print sendDocumentUsingTemplate('<Template ID>',respjson,Oauthtoken)
```

--------------------------------

### Get Template Details Response Example

Source: https://www.zoho.com/sign/api/template-managment/get-template-details.html

Example JSON response from the Zoho Sign API when retrieving template details. It includes template metadata, document information, fields, and recipient actions. The response shows a successful retrieval with status 'success' and message 'Template has been retrieved'.

```json
{
    "code": 0,
    "templates": {
        "owner_email": "v**********@***.com",
        "created_time": 1725289169093,
        "email_reminders": true,
        "document_ids": [
            {
                "document_name": "Sample Partnership Agreement",
                "pages": [
                    {
                        "page": 0,
                        "is_thumbnail": true
                    }
                ],
                "document_size": 6029,
                "document_order": "0",
                "is_editable": false,
                "total_pages": 1,
                "document_id": "14000000000516"
            }
        ],
        "notes": "",
        "reminder_period": 5,
        "owner_id": "14000000000511",
        "document_fields": [
            {
                "document_id": "14000000000516",
                "fields": [
                    {
                        "field_id": "14000000007003",
                        "x_coord": 486,
                        "field_type_id": "14000000000491",
                        "abs_height": 13,
                        "text_property": {
                            "is_italic": false,
                            "max_field_length": 2048,
                            "is_underline": false,
                            "font_color": "000000",
                            "is_fixed_width": false,
                            "font_size": 11,
                            "is_fixed_height": true,
                            "is_read_only": false,
                            "is_bold": false,
                            "font": "Roboto"
                        },
                        "field_category": "textfield",
                        "field_label": "Job title",
                        "is_mandatory": true,
                        "default_value": "",
                        "page_no": 0,
                        "document_id": "14000000000516",
                        "field_name": "Job title",
                        "y_value": 8.678756,
                        "abs_width": 98,
                        "width": 16.01006,
                        "y_coord": 69,
                        "field_type_name": "Jobtitle",
                        "description_tooltip": "",
                        "x_value": 79.39674,
                        "height": 1.683938
                    }
                ]
            }
        ],
        "description": "",
        "template_name": "Test template",
        "modified_time": 1725883497102,
        "is_deleted": false,
        "expiration_days": 15,
        "is_sequential": true,
        "template_id": "14000000000515",
        "validity": -1,
        "request_type_name": "Others",
        "owner_first_name": "V******",
        "request_type_id": "14000000000469",
        "owner_last_name": "",
        "actions": [
            {
                "ishost": false,
                "verify_recipient": false,
                "role": "student",
                "recipient_countrycode_iso": "",
                "action_type": "SIGN",
                "private_notes": "",
                "recipient_email": "",
                "language": "en",
                "recipient_phonenumber": "",
                "action_id": "14000000000542",
                "signing_order": 1,
                "fields": [
                    {
                        "field_id": "14000000000558",
                        "x_coord": 138,
                        "field_type_id": "14000000000475",
                        "abs_height": 19,
                        "field_category": "image",
                        "field_label": "Signature",
                        "is_mandatory": true,
                        "page_no": 0,
                        "document_id": "14000000000516",
                        "is_draggable": false,
                        "field_name": "Signature",
                        "y_value": 17.163212,
                        "abs_width": 135,
                        "action_id": "14000000000542",
                        "width": 22.045263,
                        "y_coord": 136,
                        "field_type_name": "Signature",
                        "description_tooltip": "",
                        "is_resizable": true,
                        "x_value": 22.565224,
                        "height": 2.46114
                    }
                ],
                "recipient_name": "",
                "delivery_mode": "EMAIL",
                "recipient_countrycode": ""
            }
        ]
    },
    "message": "Template has been retrieved",
    "status": "success"
}
```

--------------------------------

### Get document status with PHP cURL

Source: https://www.zoho.com/sign/api/use-cases/checking-the-document-status.html

Use this PHP cURL example to call the Zoho Sign API endpoint for a specific request ID. It sends a GET request with an OAuth token and prints the response or error message. The response contains request_status and actions array for checking document and recipient statuses.

```PHP
<?php
$curl = curl_init("https://sign.zoho.com/api/v1/requests/<Request-Id>");
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Authorization:Zoho-oauthtoken <Oauth-Token>'
));
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
$jsonbody = json_decode($response); // contain filed tyes response
if ($jsonbody->status == "success") {
    $createdRequestId = $jsonbody->requests->request_id;
    //Save the ID from the response to update later
    $createdRequest = new stdClass();
    $createdRequest = $jsonbody->requests;
    echo ($createdRequest);
} else //Error check for error
{
    echo $jsonbody->message;
}
curl_close($curl);
?>
```

--------------------------------

### cURL request to create a folder

Source: https://www.zoho.com/sign/api/document-managment/create-new-folder.html

Example curl command to create a new folder. Uses the Authorization header with a Zoho OAuth token.

```bash
curl https://sign.zoho.com/api/v1/folders \
    --header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5315.dxxxxxxxxxxxxxxxxxfa'
```

--------------------------------

### List signer groups response example

Source: https://www.zoho.com/sign/api/signergroups/list.html

Response example for listing signer groups. Contains a code of 0, a message, and a list of signing_groups with name, count, and ID. The page_context shows pagination details such as has_more_rows, start_index, total_count, sort_order, and row_count.

```json
{
 "code": 0,
 "signing_groups": [
 {
 "signing_group_name": "Test group",
 "signing_group_count": 5,
 "signing_group_id": "5000000005001"
 },
 {
 "signing_group_name": "Test group 2",
 "signing_group_count": 3,
 "signing_group_id": "5000000005015"
 }
 ],
 "message": "List of signer groups retrieved",
 "page_context": {
 "has_more_rows": false,
 "start_index": 1,
 "total_count": 2,
 "sort_order": "ASC",
 "row_count": 2
 },
 "status": "success"
}
```

--------------------------------

### cURL request example for fetching documents list

Source: https://www.zoho.com/sign/api/document-managment/get-document-list.html

Use this curl command to fetch the list of documents. It requires an Authorization header with a Zoho OAuth token and a data payload with page_context parameters.

```bash
curl --location --request GET 'https://sign.zoho.com/api/v1/requests' \
--header 'Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'data={
    "page_context": {
        "row_count" : ,
        "start_index" : ,
        "search_columns" : {"request_name":"payment"},
        "sort_column":"",
        "sort_order" : ""
    }
}'
```
Tokens:
Raw