Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.1!
{
  "created_time":1504087737,
  "id":1449,
  "is_ordered":false,
  "message":"Please sign this NDA.",
  "metadata":{
    "fields":[
      {
        "additional_info":"",
        "id":1,
        "required":true,
        "role_id":1,
        "type":"text"
      },
      {
        "additional_info":"",
        "id":2,
        "required":true,
        "role_id":2,
        "type":"text"
      }
    ],
    "merge_fields": [
            {
                "id": 11, 
                "label": "Company Name", 
                "required": true, 
                "type": "text"
            }, 
            {
                "id": 14, 
                "label": "Client Name", 
                "required": true, 
                "type": "text"
            }
        ], 
    "roles":[
      {
        "color":"[255, 165, 0, 0.35]",
        "fields":[
          1
        ],
        "id":1,
        "name":"client"
      },
      {
        "color":"[56, 185, 174, 0.35]",
        "fields":[
          2
        ],
        "id":2,
        "name":"manager"
      }
    ]
  },
  "modified_time":1504087873,
  "name":"NDA Template"
}

Attribute

Type

Description

name

string

The name of the template.

id

integer

Unique ID of the template.

created_time

time

The time in epoch, when the template was created.

is_ordered

integer

Flag indicating if the template was selected to be used in sequential or parallel signing.

0: Parallel signing
1: Sequential signing

The user can choose to change the type of signing during signature request initiation.

message

string

The default message that goes out with the signature requests initiated with this template.

This can be changed, during signature request initiation.

modified_time

time

The time in epoch, when the template was last modified.

metadata.fields

json

Metadata used for displaying templates on a PDF viewer. This data can be ignored.

metadata.merge_fields

json

The merge fields available in the template for your use. Use the labels to set values in these fields before the document is viewed & signed by your document signers.

metadata.roles

json

The roles added in the template. This data can be ignored.

metadata.roles.name

string

The name assigned to the role.